Open this page in the API Guide

IMultiTenancyService.TenantInfoQuery Method

Gets limited information about the tenants corresponding to query criteria.

Namespace:  Dundas.BI.AccountServices.MultiTenancy
Assembly:  Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (25.1.0.1000)
Syntax
IList<TenantInfo> TenantInfoQuery(
	int pageNumber,
	int pageSize,
	IList<Tuple<TenantQueryField, SortDirection>>? orderBy,
	ICollection<TenantQueryFilterRule>? filter
)

Parameters

pageNumber
Type: System.Int32
The page number, or 0 to indicate that all pages should be returned.
pageSize
Type: System.Int32
The number of results in each page (ignored if pageNumber is 0).
orderBy
Type: System.Collections.Generic.IList<Tuple<TenantQueryField, SortDirection>>
The sort order of the result, or null if the order does not matter.
filter
Type: System.Collections.Generic.ICollection<TenantQueryFilterRule>
The filter rules which should be applied to the query, or null if no filters are required.

Return Value

Type: IList<TenantInfo>
The collection of TenantInfo objects matching the query criteria.
Exceptions
ExceptionCondition
ArgumentOutOfRangeException

pageNumber is less than zero.

-or-

pageSize is less or equal to than zero.

InvalidOperationExceptionfilter contains an invalid rule.
FeatureNotEnabledExceptionThe multi-tenancy features of the application are not enabled.
InvalidSessionExceptionThe caller context is not associated with a valid session.
Remarks
Specifying null or Empty for filter disables any filtering. However, results will always be implicitly filtered so that they only contain information which is visible to the caller.
See Also