To filter when searching a list of Group. More...

#include <GroupFilter.h>

Public Member Functions
	GroupFilter (const GroupFilter &rh)

	GroupFilter (GroupFilter &&rh)

GroupFilter &	operator= (const GroupFilter &rh)

GroupFilter &	operator= (GroupFilter &&rh)

std::string	getQuery () const

std::string	getFilter () const

bool	getAscending () const

bool	getDeleted () const

bool	getPublicFirst () const

uint32_t	getOffset () const

uint32_t	getCount () const

std::string	getOrder () const

cbe::FilterOrder	getGroupOrder () const

cbe::GroupFilter &	setQuery (std::string)

cbe::GroupFilter &	setFilter (std::string)

cbe::GroupFilter &	setAscending (bool)

cbe::GroupFilter &	setDeleted (bool)

cbe::GroupFilter &	setOffset (uint32_t)

cbe::GroupFilter &	setCount (uint32_t)

Friends
class	Group

class	GroupQueryResult

class	GroupManager

class	delegate::SearchGroupDelegate

std::ostream &	operator<< (std::ostream &os, const GroupFilter &GroupFilter)

Detailed Description

To filter when searching a list of Group.

Member Function Documentation

◆ getAscending()

bool cbe::GroupFilter::getAscending ( ) const

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

◆ getCount()

uint32_t cbe::GroupFilter::getCount ( ) const

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

◆ getDeleted()

bool cbe::GroupFilter::getDeleted ( ) const

If deleted objects in the bin are included.

◆ getFilter()

std::string cbe::GroupFilter::getFilter ( ) const

the filter in question

◆ getGroupOrder()

cbe::FilterOrder cbe::GroupFilter::getGroupOrder ( ) const

Returns the order the query was sorted check enum FilterOrder to see options for sorting.

◆ getOffset()

uint32_t cbe::GroupFilter::getOffset ( ) const

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

◆ getOrder()

std::string cbe::GroupFilter::getOrder ( ) const

get the filterorder as a string.

◆ getPublicFirst()

bool cbe::GroupFilter::getPublicFirst ( ) const

If public groups should be sorted before private.

◆ getQuery()

std::string cbe::GroupFilter::getQuery ( ) const

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

◆ setAscending()

cbe::GroupFilter& cbe::GroupFilter::setAscending ( bool )

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

◆ setCount()

cbe::GroupFilter& cbe::GroupFilter::setCount ( uint32_t )

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()

cbe::GroupFilter& cbe::GroupFilter::setDeleted ( bool )

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

◆ setFilter()

cbe::GroupFilter& cbe::GroupFilter::setFilter ( std::string )

Not fully tested but should be a regular expression.

◆ setOffset()

cbe::GroupFilter& cbe::GroupFilter::setOffset ( uint32_t )

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()

cbe::GroupFilter& cbe::GroupFilter::setQuery ( std::string )

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.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		const GroupFilter &	GroupFilter
	)

friend

Set the order of how data will be shown by the enum of FilterOrder ex: Titel first, published e.t.c

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

include/cbe/GroupFilter.h

Public Member Functions

Friends