Resultset of data retrieved in a search for Group. More...

#include <GroupQueryResult.h>

Public Types
using	GroupsSnapshot = std::vector< Group >

Public Member Functions
	GroupQueryResult (cbe::DefaultCtor)

cbe::GroupFilter	filter () const

GroupsSnapshot	getGroupsSnapshot () const

uint64_t	GroupsLoaded () const

uint64_t	totalCount () const

bool	containsGroup (uint64_t groupId)

	operator bool () const

Friends
class	GroupManager

class	CloudBackend

std::ostream &	operator<< (std::ostream &os, const GroupQueryResult &groupQuery)

Detailed Description

Resultset of data retrieved in a search for Group.

Member Function Documentation

◆ filter()

cbe::GroupFilter cbe::GroupQueryResult::filter ( ) const

Returns a copy of the filter used for query.

◆ getGroupsSnapshot()

GroupsSnapshot cbe::GroupQueryResult::getGroupsSnapshot ( ) const

Returns a copy of a vector containing the groups for the queryResult. The queryResult will update when new data comes in but the copy will not. If iterating, make sure to create a variable for a local copy.

Returns: vector<cbe::Group> containing the groups matching the query.

◆ GroupsLoaded()

uint64_t cbe::GroupQueryResult::GroupsLoaded ( ) const

Number of groups loaded in the queryResult.

◆ totalCount()

uint64_t cbe::GroupQueryResult::totalCount ( ) const

Total number of Groups in the cloud matching the query result. This may be more than loaded.

◆ containsGroup()

bool cbe::GroupQueryResult::containsGroup ( uint64_t groupId )

asking if the group with groupId was loaded in the query.

Parameters

groupId the group id number in question

The documentation for this class was generated from the following file:

include/cbe/GroupQueryResult.h

Public Types

Public Member Functions