IDataCubeServiceDataCubeInfoQuery Method

Queries for DataCubeInfo objects according to the specified criteria.

Namespace:  Dundas.BI.Entities.DataCubes
Assembly:  Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (24.3.0.1000)
Syntax
IList<DataCubeInfo> DataCubeInfoQuery(
	ICollection<Guid> queryRootIds,
	Guid? tenantId,
	StorageType? storage,
	JobRunResult? jobRunResult,
	int pageNumber,
	int pageSize,
	IList<Tuple<FileSystemQueryField, SortDirection>> orderBy,
	ICollection<FileSystemQueryFilterRule> filter
)

Parameters

queryRootIds
Type: System.Collections.GenericICollectionGuid
The folder IDs under which to query. Use AllProjectRootFolders when requesting information for all projects.
tenantId
Type: SystemNullableGuid
The tenant ID (ignored if the caller is associated with a tenant).
storage
Type: SystemNullableStorageType
The storage category. Use when requesting information irrespective of the storage category.
jobRunResult
Type: SystemNullableJobRunResult
The latest result status for the associated job. Use when requesting information irrespective of the result.
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.GenericIListTupleFileSystemQueryField, SortDirection
The sort order of the result, or if the order does not matter.
filter
Type: System.Collections.GenericICollectionFileSystemQueryFilterRule
A filter to use when searching for data cubes. Use if a filter is not required.

Return Value

Type: IListDataCubeInfo
The list of specified DataCubeInfo.
Exceptions
ExceptionCondition
ArgumentExceptiontenantId is Empty.
ArgumentOutOfRangeExceptionpageNumber is less than zero; -or- pageSize is less or equal to than zero.
ArgumentNullExceptionqueryRootIds is .
InvalidSessionExceptionThe caller context is not associated with a valid session.
See Also