A Sandcastle Documented Class Library

# ITenantsProvider Query Method

Queries for tenant records.

Namespace: Dundas.BI.AccountServices.Extensibility
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (10.0.0.1002)
Syntax
C#
VB
C++
F#
Copy

    IList<Guid> Query(
    	int pageNumber,
    	int pageSize,
    	IList<Tuple<TenantQueryField, SortDirection>> orderBy,
    	ICollection<TenantQueryFilterRule> filter
    )

    Function Query (
    	pageNumber As Integer,
    	pageSize As Integer,
    	orderBy As IList(Of Tuple(Of TenantQueryField, SortDirection)),
    	filter As ICollection(Of TenantQueryFilterRule)
    ) As IList(Of Guid)

    IList<Guid>^ Query(
    	int pageNumber,
    	int pageSize,
    	IList<Tuple<TenantQueryField, SortDirection>^>^ orderBy,
    	ICollection<TenantQueryFilterRule^>^ filter
    )

    abstract Query :
            pageNumber : int *
            pageSize : int *
            orderBy : IList<Tuple<TenantQueryField, SortDirection>> *
            filter : ICollection<TenantQueryFilterRule> -> IList<Guid>

#### Parameters

pageNumber
  Type: System
  Int32
  The page number.
pageSize
  Type: System
  Int32
  The number of results in each page.
orderBy
  Type: System.Collections.Generic
  IList
  Tuple
  TenantQueryField, SortDirection
  The sort order of the result, or
  if the order does not matter.
filter
  Type: System.Collections.Generic
  ICollection
  TenantQueryFilterRule
  The filter rules which should be applied to the query, or
  if no filters are required.

#### Return Value

Type: IList
Guid
The records matching the search criteria.
Remarks

Notes to Implementers
This method only needs to be implemented if SupportedQueryOperations includes one or more of Filter, OrderBy, or Paging. Otherwise, the method will not be called and implementers should throw a NotSupportedException.

See Also

#### Reference

ITenantsProvider Interface
Dundas.BI.AccountServices.Extensibility Namespace