CBEQueryResult

Introduction

resultset of data retrieved.

Methods

-containersLoaded

-containsItem:

-filter

-getItemsSnapshot

-itemsLoaded

-objectsLoaded

-totalCount

containersLoaded

-(uint64_t) containersLoaded; 

Discussion

Returns number of \c containers loaded in to the query result.

containsItem:

-(bool) containsItem:(CBEItemId) itemId; 

Parameters

Discussion

Checks if the Item with id is in the resultset.

filter

-(CBEFilter*) filter; 

Discussion

Returns a copy of the filter used for query.

getItemsSnapshot

-(NSArray*) getItemsSnapshot; 

Return Value

The items matching the query.

Discussion

Returns a copy of a vector containing the items for this QueryResult. The QueryResult will be updated when new data comes in, but the returned copy will not. If iterating make sure to create a variable for a local copy.

itemsLoaded

-(uint64_t) itemsLoaded; 

Discussion

Number of \c items loaded in current QueryResult.

objectsLoaded

-(uint64_t) objectsLoaded; 

Discussion

Returns number of \c objects loaded in to the query result.

totalCount

-(uint64_t) totalCount; 

Discussion

total number of items in the cloud matching the query result. This may be more than loaded.