IFileSystemServiceFileSystemQuery(Int32, Int32, Guid, FileSystemQueryOptions, IListTupleFileSystemQueryField, SortDirection, ICollectionFileSystemQueryFilterRule) Method

Queries file system entries corresponding to the specified criteria.

Namespace: Dundas.BI.FileSystem
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (26.2.0.1000)
Syntax
IList<FileSystemEntry> FileSystemQuery(
	int pageNumber,
	int pageSize,
	Guid queryRootId,
	FileSystemQueryOptions queryOptions,
	IList<Tuple<FileSystemQueryField, SortDirection>>? orderBy,
	ICollection<FileSystemQueryFilterRule>? filter
)

Parameters

pageNumber  Int32
The page number, or 0 to indicate that all pages should be returned.
pageSize  Int32
The number of results in each page (ignored if pageNumber is 0).
queryRootId  Guid
The ID of the entry where the query starts.
queryOptions  FileSystemQueryOptions
A bit mask comprised of one or more FileSystemQueryOptions that specify how the query is performed.
orderBy  IListTupleFileSystemQueryField, SortDirection
The sort order of the result, or if the order does not matter.
filter  ICollectionFileSystemQueryFilterRule
The filter rules which should be applied to the query, or if no filters are required.

Return Value

IListFileSystemEntry
The collection of FileSystemEntry objects matching the query criteria.
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionpageNumber is less than zero; -or- pageSize is less or equal to than zero.
ArgumentExceptionqueryRootId is Empty.
NotFoundExceptionThe entry specified by queryRootId does not exist.
InvalidOperationException

An invalid field was specified in orderBy.

-or-

filter contains an invalid rule.

NoPrivilegeException The caller does not have permission to access a query root, and SkipQueryRootSecurityCheck has not been specified.
InvalidSessionExceptionThe caller context is not associated with a valid session.
Remarks
To query under all standard projects, specify ProjectsRootFolder as the query root ID.
See Also