ITokenServiceTokenQuery Method

Gets the tokens corresponding to the query criteria.

Namespace: Dundas.BI.Data.Parameters.Tokens
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (26.2.0.1000)

Syntax

C++

Copy

IList<TokenDefinition> TokenQuery(
	int pageNumber,
	int pageSize,
	IList<Tuple<TokenQueryField, SortDirection>>? orderBy,
	ICollection<TokenQueryFilterRule>? filter
)

Function TokenQuery ( 
	pageNumber As Integer,
	pageSize As Integer,
	orderBy As IList(Of Tuple(Of TokenQueryField, SortDirection)),
	filter As ICollection(Of TokenQueryFilterRule)
) As IList(Of TokenDefinition)

IList<TokenDefinition^>^ TokenQuery(
	int pageNumber, 
	int pageSize, 
	IList<Tuple<TokenQueryField, SortDirection>^>^ orderBy, 
	ICollection<TokenQueryFilterRule^>^ filter
)

abstract TokenQuery : 
        pageNumber : int * 
        pageSize : int * 
        orderBy : IList<Tuple<TokenQueryField, SortDirection>> * 
        filter : ICollection<TokenQueryFilterRule> -> IList<TokenDefinition>

Parameters

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

Return Value

IListTokenDefinition
The collection of token definitions 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.
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

The results are automatically filtered to exclude tokens which are not accessible to the caller.

Reference

ITokenService Interface

Dundas.BI.Data.Parameters.Tokens Namespace