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

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 (24.4.0.1000)
Syntax
IList<FileSystemEntry> FileSystemQuery(
	int pageNumber,
	int pageSize,
	Guid queryRootId,
	FileSystemQueryOptions queryOptions,
	IList<Tuple<FileSystemQueryField, SortDirection>>? orderBy,
	ICollection<FileSystemQueryFilterRule>? 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).
queryRootId
Type: SystemGuid
The ID of the entry where the query starts.
queryOptions
Type: Dundas.BI.FileSystemFileSystemQueryOptions
A bit mask comprised of one or more FileSystemQueryOptions that specify how the query is performed.
orderBy
Type: System.Collections.GenericIListTupleFileSystemQueryField, SortDirection
The sort order of the result, or if the order does not matter.
filter
Type: System.Collections.GenericICollectionFileSystemQueryFilterRule
The filter rules which should be applied to the query, or if no filters are required.

Return Value

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