IGroupServiceGroupQuery Method

Gets the groups corresponding to query criteria.

Namespace: Dundas.BI.AccountServices
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (26.2.0.1000)

Syntax

C++

Copy

IList<Group> GroupQuery(
	int pageNumber,
	int pageSize,
	IList<Tuple<GroupQueryField, SortDirection>>? orderBy,
	ICollection<GroupQueryFilterRule>? filter
)

Function GroupQuery ( 
	pageNumber As Integer,
	pageSize As Integer,
	orderBy As IList(Of Tuple(Of GroupQueryField, SortDirection)),
	filter As ICollection(Of GroupQueryFilterRule)
) As IList(Of Group)

IList<Group^>^ GroupQuery(
	int pageNumber, 
	int pageSize, 
	IList<Tuple<GroupQueryField, SortDirection>^>^ orderBy, 
	ICollection<GroupQueryFilterRule^>^ filter
)

abstract GroupQuery : 
        pageNumber : int * 
        pageSize : int * 
        orderBy : IList<Tuple<GroupQueryField, SortDirection>> * 
        filter : ICollection<GroupQueryFilterRule> -> IList<Group>

Parameters

pageNumber Int32: The page number.
pageSize Int32: The number of results in each page.
orderBy IListTupleGroupQueryField, SortDirection: The sort order of the result, or if the order does not matter.
filter ICollectionGroupQueryFilterRule: The filter rules which should be applied to the query, or if no filtering is required.

Return Value

IListGroup
The groups matching the search criteria.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	pageNumber is less than zero. -or- pageSize is less or equal to than zero.
InvalidOperationException	filter contains invalid rule.
NoPrivilegeException	The caller does not have system administration privileges. -or- The caller is associated with a tenant, but does not have administration privileges for that tenant. -or- The caller does not have administrative privileges on any projects.
InvalidSessionException	The caller context is not associated with a valid session.

Remarks

If the caller is associated with a tenant, the results will be filtered so that only groups associated with that tenant are included.

Reference

IGroupService Interface

Dundas.BI.AccountServices Namespace