IGroupServiceGroupInfoQuery Method

Gets limited information about the groups corresponding to query criteria.

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

Syntax

C++

Copy

IList<MemberInfo> GroupInfoQuery(
	int pageNumber,
	int pageSize,
	IList<Tuple<GroupInfoQueryField, SortDirection>>? orderBy,
	ICollection<GroupInfoQueryFilterRule>? filter
)

Function GroupInfoQuery ( 
	pageNumber As Integer,
	pageSize As Integer,
	orderBy As IList(Of Tuple(Of GroupInfoQueryField, SortDirection)),
	filter As ICollection(Of GroupInfoQueryFilterRule)
) As IList(Of MemberInfo)

IList<MemberInfo^>^ GroupInfoQuery(
	int pageNumber, 
	int pageSize, 
	IList<Tuple<GroupInfoQueryField, SortDirection>^>^ orderBy, 
	ICollection<GroupInfoQueryFilterRule^>^ filter
)

abstract GroupInfoQuery : 
        pageNumber : int * 
        pageSize : int * 
        orderBy : IList<Tuple<GroupInfoQueryField, SortDirection>> * 
        filter : ICollection<GroupInfoQueryFilterRule> -> IList<MemberInfo>

Parameters

pageNumber: Type: SystemInt32
The page number.
pageSize: Type: SystemInt32
The number of results in each page.
orderBy: Type: System.Collections.GenericIListTupleGroupInfoQueryField, SortDirection
The sort order of the result, or if the order does not matter.
filter: Type: System.Collections.GenericICollectionGroupInfoQueryFilterRule
The filter rules which should be applied to the query, or if no filtering is required.

Return Value

Type: IListMemberInfo
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.
InvalidSessionException	The caller context is not associated with a valid session.

Exception

Condition

ArgumentOutOfRangeException

pageNumber is less than zero.

-or-

pageSize is less or equal to than zero.

InvalidOperationException

filter contains invalid rule.

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.