IMultiTenancyServiceTenantInfoQuery 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 (24.3.0.1000)
Syntax
Copy
IList<TenantInfo> TenantInfoQuery(
	int pageNumber,
	int pageSize,
	IList<Tuple<TenantQueryField, SortDirection>>? orderBy,
	ICollection<TenantQueryFilterRule>? filter
)

Parameters

pageNumber
Type: SystemInt32
The page number, or 0 to indicate that all pages should be returned.
pageSize
Type: SystemInt32
The number of results in each page (ignored if pageNumber is 0).
orderBy
Type: System.Collections.GenericIListTupleTenantQueryField, SortDirection
The sort order of the result, or if the order does not matter.
filter
Type: System.Collections.GenericICollectionTenantQueryFilterRule
The filter rules which should be applied to the query, or if no filters are required.

Return Value

Type: IListTenantInfo
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 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