IDataCubeService.DataCubeInfoQuery 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 (25.1.0.1000)

Syntax

C++

Copy

IList<DataCubeInfo> DataCubeInfoQuery(
	ICollection<Guid> queryRootIds,
	Guid? tenantId,
	StorageType? storage,
	JobRunResult? jobRunResult,
	int pageNumber,
	int pageSize,
	IList<Tuple<FileSystemQueryField, SortDirection>> orderBy,
	ICollection<FileSystemQueryFilterRule> filter
)

Function DataCubeInfoQuery ( 
	queryRootIds As ICollection(Of Guid),
	tenantId As Guid?,
	storage As StorageType?,
	jobRunResult As JobRunResult?,
	pageNumber As Integer,
	pageSize As Integer,
	orderBy As IList(Of Tuple(Of FileSystemQueryField, SortDirection)),
	filter As ICollection(Of FileSystemQueryFilterRule)
) As IList(Of DataCubeInfo)

IList<DataCubeInfo^>^ DataCubeInfoQuery(
	ICollection<Guid>^ queryRootIds, 
	Nullable<Guid> tenantId, 
	Nullable<StorageType> storage, 
	Nullable<JobRunResult> jobRunResult, 
	int pageNumber, 
	int pageSize, 
	IList<Tuple<FileSystemQueryField, SortDirection>^>^ orderBy, 
	ICollection<FileSystemQueryFilterRule^>^ filter
)

abstract DataCubeInfoQuery : 
        queryRootIds : ICollection<Guid> * 
        tenantId : Nullable<Guid> * 
        storage : Nullable<StorageType> * 
        jobRunResult : Nullable<JobRunResult> * 
        pageNumber : int * 
        pageSize : int * 
        orderBy : IList<Tuple<FileSystemQueryField, SortDirection>> * 
        filter : ICollection<FileSystemQueryFilterRule> -> IList<DataCubeInfo>

Parameters

queryRootIds: Type: System.Collections.Generic.ICollection<Guid>
The folder IDs under which to query. Use AllProjectRootFolders when requesting information for all projects.
tenantId: Type: System.Nullable<Guid>
The tenant ID (ignored if the caller is associated with a tenant).
storage: Type: System.Nullable<StorageType>
The storage category. Use null when requesting information irrespective of the storage category.
jobRunResult: Type: System.Nullable<JobRunResult>
The latest result status for the associated job. Use null when requesting information irrespective of the result.
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).
orderBy: Type: System.Collections.Generic.IList<Tuple<FileSystemQueryField, SortDirection>>
The sort order of the result, or null if the order does not matter.
filter: Type: System.Collections.Generic.ICollection<FileSystemQueryFilterRule>
A filter to use when searching for data cubes. Use null if a filter is not required.

Return Value

Type: IList<DataCubeInfo>
The list of specified DataCubeInfo.

Exceptions

Exception	Condition
ArgumentException	tenantId is Empty.
ArgumentOutOfRangeException	pageNumber is less than zero; -or- pageSize is less or equal to than zero.
ArgumentNullException	queryRootIds is null.
InvalidSessionException	The caller context is not associated with a valid session.

Reference

IDataCubeService Interface

Dundas.BI.Entities.DataCubes Namespace

IDataCubeService.AddLanguageSpecificTextSet("LSTB6C235AB_0?cpp=::|nu=.");DataCubeInfoQuery Method

Parameters

Return Value

Reference

IDataCubeService.DataCubeInfoQuery Method