ISessionServiceSessionQuery Method

Gets the sessions corresponding to the 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<Session> SessionQuery(
	int pageNumber,
	int pageSize,
	IList<Tuple<SessionQueryField, SortDirection>>? orderBy,
	ICollection<SessionQueryFilterRule>? filter
)

Function SessionQuery ( 
	pageNumber As Integer,
	pageSize As Integer,
	orderBy As IList(Of Tuple(Of SessionQueryField, SortDirection)),
	filter As ICollection(Of SessionQueryFilterRule)
) As IList(Of Session)

IList<Session^>^ SessionQuery(
	int pageNumber, 
	int pageSize, 
	IList<Tuple<SessionQueryField, SortDirection>^>^ orderBy, 
	ICollection<SessionQueryFilterRule^>^ filter
)

abstract SessionQuery : 
        pageNumber : int * 
        pageSize : int * 
        orderBy : IList<Tuple<SessionQueryField, SortDirection>> * 
        filter : ICollection<SessionQueryFilterRule> -> IList<Session>

Parameters

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

Return Value

IListSession
The collection of sessions matching the query 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.
InvalidSessionException	The caller context is not associated with a valid session.

Remarks

This method requires that the current session have administrative privileges.

Reference

ISessionService Interface

Dundas.BI.AccountServices Namespace