CBEGroupFilter

Introduction

to filter when searching a list of Group.

Methods

-getAscending

-getCount

-getDeleted

-getOffset

-getQuery

-setAscending:

-setCount:

-setDeleted:

-setFilter:

-setOffset:

-setQuery:

getAscending

-(bool) getAscending; 

Discussion

Returns the settings on how the data was sorted and displayed.

getCount

-(uint32_t) getCount; 

Discussion

Returns the value of the count that was set for the query.

getDeleted

-(bool) getDeleted; 

Discussion

If deleted objects in the bin are included.

getOffset

-(uint32_t) getOffset; 

Discussion

Returns the offset that was used for the filter in the query.

getQuery

-(NSString*) getQuery; 

Discussion

Returns the query string that was set on the filter. E.g., name:Abc*

setAscending:

-(void) setAscending:(bool)ascending; 

Discussion

Sets the Order in which data should be displayed: Acending meaning alfabetical

setCount:

-(void) setCount:(uint32_t)count; 

Discussion

Set the Number of items you want to get from a container. So if a container has 50 items but you only want the 10 first in ascending order then set ascending to true and setCount to 10.

setDeleted:

-(void) setDeleted:(bool)deleted; 

Discussion

If you want to see deleted groups set deleted to true.

setFilter:

-(void) setFilter:(NSString*)filter; 

Discussion

Not fully tested but should be a regular expression.

setOffset:

-(void) setOffset:(uint32_t)offset; 

Discussion

Set the offset for paging, offset is the item offset where to start your query. i.e: There is already a query of the first 99 items and to get the rest you have setOffest to 100 to get the next set.

setQuery:

-(void) setQuery:(NSString*)query; 

Discussion

Set the query string, e.g: Name:* (would search for all objects with the metadata key of Name). \note If used with rootContainer id as the dataId, search in the whole account will be done.