IDSSCubeSource Interface Reference

List of all members.

---

Detailed Description

The interface IDSSCubeSource is used to retrieve data from or information about a published cube instance.

This interface is used to provide access to published cube instances. In particular it is exposed by the cube server, which manages cube instances. It is also offered by client cube server, which provides an efficient connection to a remote cube server.

The following methods appear on the IDSSCubeSource interface:

Public Member Functions
HRESULT	ExecuteSearch ([in] BSTR pID,[in] BSTR pVersionID,[in] IDSSSearch *ipSearch,[in, optional, defaultvalue(1)] Int32 iFirstObject,[in, optional] IDSSFolder *ipSearchFolder,[in, optional] IDSSUserRuntime *ipUserRuntime,[in, optional, defaultvalue(DssSourceDefn)] EnumDSSSourceFlags iSourceFlags,[in, optional, defaultvalue(DssWorkingSetSearchReserved)] EnumDSSWorkingSetSearchFlags iFlags,[out, optional] Int32 *opCount,[out, retval] IDSSFolder oppSearchFolder)
HRESULT	GetCubeInfo ([in] BSTR pCubeID,[in, optional] IDSSUserRuntime *pUserRuntime,[out, retval] IDSSCubeInfos ppInfos)
	Cube information.
HRESULT	GetDataFilter ([in] BSTR pID,[in] BSTR pVersionID,[out, retval] IDSSFilter ppFilter)
	Get data filter of the cube instance.
HRESULT	GetDataTemplate ([in] BSTR pID,[in] BSTR pVersionID,[out, retval] IDSSTemplate ppTemplate)
	Get data template of the cube instance.
HRESULT	GetElements ([in] BSTR pID,[in] BSTR pVersionID,[in] IDSSObjectInfo *pObject,[in] IDSSFilter *pFilter,[in, optional, defaultvalue(-1)] Int32 MaxSize,[in, optional, defaultvalue(1)] Int32 FirstElement,[in, optional] IDSSUserRuntime *pUserRuntime,[in, optional] Int32 Flags,[in, optional] Int32 Cookie,[in, optional] Int32 UserData,[out, retval] IDSSElements ppElements)
	Get elements from a template unit object as children of its parent element.
HRESULT	UnitObjects ([in] BSTR pID,[in] BSTR pVersionID,[in, optional] VARIANT_BOOL ShowAllObjects,[in, optional] IDSSUserRuntime *pUserRuntime,[in, optional] Int32 Flags,[in, optional] Int32 Cookie,[in, optional] Int32 UserData,[out, retval] IDSSCollection ppObjects)
	Template unit objects from this cube instance.

---

Member Function Documentation

HRESULT IDSSCubeSource::ExecuteSearch (  [in] BSTR  pID, [in] BSTR  pVersionID, [in] IDSSSearch *  ipSearch, [in, optional, defaultvalue(1)] Int32  iFirstObject, [in, optional] IDSSFolder *  ipSearchFolder, [in, optional] IDSSUserRuntime *  ipUserRuntime, [in, optional, defaultvalue(DssSourceDefn)] EnumDSSSourceFlags  iSourceFlags, [in, optional, defaultvalue(DssWorkingSetSearchReserved)] EnumDSSWorkingSetSearchFlags  iFlags, [out, optional] Int32 *  opCount, [out, retval] IDSSFolder   oppSearchFolder )

HRESULT IDSSCubeSource::GetCubeInfo (  [in] BSTR  pCubeID, [in, optional] IDSSUserRuntime *  pUserRuntime, [out, retval] IDSSCubeInfos   ppInfos )

Cube information. Parameters: pCubeID  GUID of the cube definition pUserRuntime  User runtime ppInfos  Collection of cube info Returns: Usual COM result code: S_OK

HRESULT IDSSCubeSource::GetDataFilter (  [in] BSTR  pID, [in] BSTR  pVersionID, [out, retval] IDSSFilter   ppFilter )

Get data filter of the cube instance. Parameters: pID  GUID of the cube instance pVersionID  GUID of the version of the cube instance ppFilter  Returns the data filter.

HRESULT IDSSCubeSource::GetDataTemplate (  [in] BSTR  pID, [in] BSTR  pVersionID, [out, retval] IDSSTemplate   ppTemplate )

Get data template of the cube instance. Parameters: pID  GUID of the cube instance pVersionID  GUID of the version of the cube instance ppTemplate  Returns the data template.

HRESULT IDSSCubeSource::GetElements (  [in] BSTR  pID, [in] BSTR  pVersionID, [in] IDSSObjectInfo *  pObject, [in] IDSSFilter *  pFilter, [in, optional, defaultvalue(-1)] Int32  MaxSize, [in, optional, defaultvalue(1)] Int32  FirstElement, [in, optional] IDSSUserRuntime *  pUserRuntime, [in, optional] Int32  Flags, [in, optional] Int32  Cookie, [in, optional] Int32  UserData, [out, retval] IDSSElements   ppElements )

Get elements from a template unit object as children of its parent element. GetElements call can be executed synchronously or asynchronously as indicated by Flags Parameters: pID  GUID of the cube instance pVersionID  GUID of the version of the cube instance pObject  The template unit object these elements correspond to. pFilter  Filter on the elements brought back. MaxSize  Maximum number of elements to bring back. FirstElement  Offset of the first element. Flags  0 - synch, 1 - asynch pUserRuntime  User on whose behalf we move the object. Cookie  Identifies the callback site, if a callback response is requested. UserData  Caller's reference number, used by the caller to identify this call. ppElements  Collection of elements. Returns: Usual COM result code: S_OK

HRESULT IDSSCubeSource::UnitObjects (  [in] BSTR  pID, [in] BSTR  pVersionID, [in, optional] VARIANT_BOOL  ShowAllObjects, [in, optional] IDSSUserRuntime *  pUserRuntime, [in, optional] Int32  Flags, [in, optional] Int32  Cookie, [in, optional] Int32  UserData, [out, retval] IDSSCollection   ppObjects )

Template unit objects from this cube instance. UnitObjects call can be executed synchronously or asynchronously as indicated by Flags Parameters: pID  GUID of the cube instance pVersionID  GUID of the version of the cube instance ShowAllObjects  Whether we should include all objects in the collection. pUserRuntime  User on whose behalf we move the object. Flags  0 - synch, 1 - asynch Cookie  Identifies the callback site, if a callback response is requested. UserData  Caller's reference number, used by the caller to identify this call. ppObjects  Return collection of template unit objects. Returns: Usual COM result code: S_OK

---