A Sandcastle Documented Class Library

# IFileSystemService RevisionQuery Method

Queries file system revision history corresponding to the specified criteria.

Namespace: Dundas.BI.FileSystem
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<RevisionInfo> RevisionQuery(
    	int pageNumber,
    	int pageSize,
    	Guid queryRootId,
    	FileSystemQueryOptions queryOptions,
    	IList<Tuple<RevisionQueryField, SortDirection>> orderBy,
    	ICollection<RevisionQueryFilterRule> filter
    )

    Function RevisionQuery (
    	pageNumber As Integer,
    	pageSize As Integer,
    	queryRootId As Guid,
    	queryOptions As FileSystemQueryOptions,
    	orderBy As IList(Of Tuple(Of RevisionQueryField, SortDirection)),
    	filter As ICollection(Of RevisionQueryFilterRule)
    ) As IList(Of RevisionInfo)

    IList<RevisionInfo^>^ RevisionQuery(
    	int pageNumber,
    	int pageSize,
    	Guid queryRootId,
    	FileSystemQueryOptions queryOptions,
    	IList<Tuple<RevisionQueryField, SortDirection>^>^ orderBy,
    	ICollection<RevisionQueryFilterRule^>^ filter
    )

    abstract RevisionQuery :
            pageNumber : int *
            pageSize : int *
            queryRootId : Guid *
            queryOptions : FileSystemQueryOptions *
            orderBy : IList<Tuple<RevisionQueryField, SortDirection>> *
            filter : ICollection<RevisionQueryFilterRule> -> IList<RevisionInfo>

#### 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).
queryRootId
  Type: System
  Guid
  The ID of the entry where the query starts.
queryOptions
  Type: Dundas.BI.FileSystem
  FileSystemQueryOptions
  A bit mask comprised of one or more FileSystemQueryOptions that specify how the query is performed.
orderBy
  Type: System.Collections.Generic
  IList
  Tuple
  RevisionQueryField, SortDirection
  The sort order of the result, or
  if the order does not matter.
filter
  Type: System.Collections.Generic
  ICollection
  RevisionQueryFilterRule
  The filter rules which should be applied to the query, or
  if no filters are required.

#### Return Value

Type: IList
RevisionInfo
A collection of RevisionInfo objects matching the query criteria.
Exceptions

Exception | Condition
--- | ---
ArgumentOutOfRangeException | pageNumber is less than zero; -or- pageSize is less or equal to than zero.
ArgumentException | queryRootId is Empty.
NotFoundException | The entry specified by queryRootId does not exist.
InvalidOperationException | filter contains invalid rule.
NoPrivilegeException | The caller does not have permission to access the entry specified by queryRootId.
InvalidSessionException | The caller context is not associated with a valid session.

Remarks
To query the entire application file system, specify ProjectsRootFolder as the value of queryRootId.
See Also

#### Reference

IFileSystemService Interface
Dundas.BI.FileSystem Namespace