The proCube.Api namespace contains interfaces and classes for interacting with a proCube server.
Classes
| Class | Description | |
|---|---|---|
 | Collection<(Of <(T>)>) | .NET Only. Base collection class.
|
| Comparer | .NET Only. String comparer.
|
| CubeCustomSubset | .NET Only. Subset of CubeMember objects.
|
| CustomSubset | .NET Only. Subset of Member objects.
|
| CustomSubset<(Of <(M>)>) | .NET Only. Base class for a set of Member objects.
|
| DefaultContinueObject | Framework class used for cancelling a process.
|
| DimensionDrillThroughFields | The drillthrough fields for a particular dimension; used to form parameteres for drillthrough method call. .NET Only.
|
| DrillThroughFlags | Flags to use for a DrillThrough method call.
|
| ExportParams | |
| FactData | Object represntation of a factdata object.
|
| Factory | Starting class to access Databases and Servers collections.
|
| FactValue | Object represntation of a factdata value.
|
| ImportParams | |
| MetaCollection<(Of <(T>)>) | .NET Only. Base collection class for Meta items.
|
 | MetaCollection<(Of <(T>)>)..::.Tag | .NET Only. Internal tag object used for indexing meta collection.
|
| StringArray | An array of String objects.
|
| StringCollection | A collection of String objects.
|
| TableDimension | Definition of a Dimension used on a Table call to retrieve data.
|
Interfaces
| Interface | Description | |
|---|---|---|
 | AccessRight | Base class for AccessRight objects.
|
| AccessRights | Deprecated.
|
| AccessRightsArray | Read-only collection of AccessRight objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| Alias | Object representation of an Alias for a Member.
|
| Aliases | Editable collection of Alias objects.
|
| AliasesArray | Read-only collection of Alias objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| AliasGroup | Object representation of an AliasGroup for a Dimension.
|
| AliasGroups | Editable collection of AliasGroup objects.
|
| AliasGroupsArray | Read-only collection of AliasGroup objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| Axes | Editable collection of Axis objects.
|
| AxesArray | Read-only collection of Axis objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| Axis | .NET Only. Collection of SliceDimensions along a row/column of a Slice.
|
| BaseExportParams | Base class used for specifying export parameters.
|
| BaseImportParams | Base class used for specifying import parameters.
|
| Cellset | Section of fact values.
|
| Connection | A connection to a Database.
|
| Coordinate | Collection of CubeMember objects that together form a specific point.
|
| Coordinates | Editable collection of Coordinate objects.
|
| Cube | Object representation of a Cube.
|
| CubeAccessRightGroup | Collection of all security objects relating a SecurityGroup to a Cube.
|
| CubeAccessRightGroups | Collection of CubeAccessRightGroup objects in a Security object of a Database.
|
| CubeAccessRightGroupsArray | Read-only collection of CubeAccessRightGroup objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| CubeAlias | Object representation of an Alias for a Member in a Cube.
|
| CubeAliases | Editable collection of CubeAlias objects.
|
| CubeAliasesArray | Read-only collection of CubeAlias objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| CubeAliasGroup | Object representation of an AliasGroup for a CubeDimension.
|
| CubeAliasGroups | Editable collection of CubeAliasGroup objects.
|
| CubeAliasGroupsArray | Read-only collection of CubeAliasGroup objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| CubeDimension | Object representation of a Cube Dimension.
|
| CubeDimensionExportInfo | Specification for a dimension of the members whose factdata is to be exported.
|
| CubeDimensionExportInfosCollection | Editable collection of CubeDimensionExportInfo objects.
|
| CubeDimensions | Editable collection of CubeDimension objects.
|
| CubeDimensionsArray | Read-only collection of CubeDimension objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| CubeDimensionsCollection | Editable collection of CubeDimension objects.
|
| CubeMember | Object representation of a Member that exists in a Cube.
|
| CubeMembers | Editable collection of CubeMember objects.
|
| CubeMembersArray | Read-only collection of CubeMember objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| CubeMembersCollection | Editable collection of CubeMember objects.
|
| CubeProperties | Editable collection of CubeProperty objects.
|
| CubePropertiesArray | Read-only collection of CubeProperty objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| CubeProperty | Object representation of an Property of a CubeMember.
|
| CubePropertyGroup | Object representation of an Property Group for a CubeDimension.
|
| CubePropertyGroups | Editable collection of CubePropertyGroup objects.
|
| CubePropertyGroupsArray | Read-only collection of CubePropertyGroup objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| CubeReference | A Cube/Dimensions/Members grouping.
|
| CubeReferences | A user-editable collection of Cubes used for rebuilds.
|
| Cubes | Editable collection of Cube objects.
|
| CubesArray | Read-only collection of Cube objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| CubesCollection | Editable collection of Cube objects.
|
| CubeSubset | Object representation of a CubeSubset.
|
| CubeSubsets | Editable collection of CubeSubset objects.
|
| CubeSubsetsArray | Read-only collection of CubeSubset objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| CubeTransition | Parameters for a Cube tranfer. .NET Only.
|
| Database | Object Representation of a Database.
|
| DatabaseInfo | Holds meta information related to the Database.
|
| Databases | Collection of Database objects on a Server or Servers.
|
| DatabasesArray | Read-only collection of Database objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| DatabasesInfo | Editable collection of DatabaseInfo objects.
|
| DatabasesInfoArray | Read-only collection of DatabaseInfo objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| DestinationDimensionInfo | Defines how factdata is to be imported into a Dimension.
|
| DestinationDimensionInfos | Editable collection of DestinationDimensionInfo objects.
|
| Dimension | Object representation of a Dimension.
|
| DimensionAccessRightGroup | Grouping of security objects relating a SecurityGroup to a Dimension.
|
| DimensionAccessRightGroups | Collection of DimensionAccessRightGroup objects in a Security object of a Database.
|
| DimensionAccessRightGroupsArray | Read-only collection of DimensionAccessRightGroup objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| DimensionReference | A Dimension/Members pairing.
|
| Dimensions | Editable collection of Dimension objects.
|
| DimensionsArray | Read-only collection of Dimension objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| DimensionsCollection | Editable collection of Dimension objects.
|
| DimensionsReferences | A collection of DimensionReferences that can only be added to.
|
| DrillThroughDetail | Detail of a DrillThrough record.
|
| DrillThroughDetails | Collection of DrillThroughDetail objects used in a DrillThroughRecord.
|
| DrillThroughRecord | Single record of a DrillThrough result.
|
| DrillThroughRecords | Collection of DrillThroughRecord objects which are the result of a DrillThrough call.
|
| DrillThroughResult | Set of results returned from a DrillThrough call.
|
| Edge | A collection of Tuples that defines the edge of a Cell.
|
| ExportFactDataInfo | Parameters for ExportFactData method. Result from a call to PrepareExportFactDataParam.
|
| ExportMetaDataInfo | Parameters for ExportMetaData method. Result from a call to PrepareExportMetaDataParam.
|
| ExportTransactionLogInfo | Parameters for ExportTransactionLog method. Result from a call to PrepareExportTransactionLogParam.
|
| FactDataArray | Read-only collection of FactData objects.
|
| FactSecurities | Collection of FactSecurity objects in a Security object of a Database.
|
| FactSecuritiesArray | Read-only collection of FactSecurity objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| FactSecurity | A single FactSecurity rule.
|
| IArray<(Of <(T>)>) | Base interface for an array. .Net Only.
|
| IChangeable | .NET Only. Base class for changeable object.
|
| ICollection<(Of <(T>)>) | Base interface for collections. .NET only.
|
| ICollectionDescription | .NET Only. Interface for collections that provides self-describing capabilities.
|
| IContinue | Callback and object used to cancel an import/export process. .NET Only.
|
| IDiscardable | .NET Only. IDiscard interface.
|
| IDumpObject | .NET Only. Object used to create cache dumps.
|
| IDumpWriter | .NET Only. Interface for writing a dump.
|
| IEditableMetaCollection<(Of <(T>)>) | Interface for an editable collection of metadata objects. .NET only.
|
| IMetaCollection<(Of <(T>)>) | Interface for collection of metadata objects. .NET only.
|
| ImportFactDataInfo | Parameters for ImportFactData method. Result from a call to PrepareImportFactDataParam.
|
| ImportMetaDataInfo | Parameters for ImportMetaData method. Result from a call to PrepareImportMetaDataParam.
|
| INotifyCollection | .NET only. Interface for collections to send events when items are added or removed from the collection.
|
| INotifyCollection<(Of <(ARRAY>)>) | .NET only. Interface for collections to send events when items are added or removed from the collection.
|
| INotifyObject | .NET Only. INotifyObject interface is for updateable metadata objects.
|
| IObjectResolve<(Of <(T>)>) | .NET Only. Base class for collections that resolve a string to an object.
|
| IRefMetaCollection<(Of <(T>)>) | Interface for an editable collection of metadata objects. .NET only.
|
| IStringArray | Read-only collection of Strings. .NET only.
|
| IStringCollection | Collection of Strings. .NET only.
|
| Member | Object representation of a Member.
|
| Members | Editable collection of Member objects.
|
| MembersArray | Read-only collection of Member objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| MembersCollection | Editable collection of Member objects.
|
| MembersReferences | A user-editable collection of Members used for cube transfers.
|
| Meta | Meta is the base interface for metadata objects.
|
| MetaArray | Interface for read-only collection of metadata objects.
|
| MetaCollection | Interface for collection of metadata objects.
|
| Monitor | Used for getting information about and managing the processees on a Server.
|
| Operation | An operation on the Server.
|
| OperationsArray | Read-only collection of Operation objects.
|
| Properties | Editable collection of Property objects.
|
| PropertiesArray | Read-only collection of Property objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| Property | Object representation of an Property of a Member.
|
| PropertyGroup | Object representation of an Property Group for a Dimension.
|
| PropertyGroups | Editable collection of PropertyGroup objects.
|
| PropertyGroupsArray | Read-only collection of PropertyGroup objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| Query | Query object used to create a Pivot or Slice.
|
| RebuildCubeInfo | Set of parameters for a Cube rebuild.
|
| RefCubeMember | Object representation of a reference to a CubeMember.
|
| ReferencedCubeMembers | Editable collection of CubeMember objects.
|
| ReferencedMembers | Editable collection of Member objects.
|
| RequestedPoint | Results of a single point from the DrillThrough.
|
| RequestedPoints | Collection of the RequestPoint objects returned from a DrillThrough call.
|
| Security | Object representation of the global security information for a Database.
|
| SecurityGroup | A security group used to group users.
|
| SecurityGroups | Interface for an editable collection of SecurityGroup objects.
|
| SecurityGroupsArray | Read-only collection of SecurityGroup objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| SecurityGroupUser | SecurityUser who is in a SecurityGroup.
|
| SecurityGroupUsers | Collection of SecurityGrupUser objects in a Security object of a Database.
|
| SecurityGroupUsersArray | Read-only collection of SecurityGroupUser objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| SecurityPrincipal | Base class for a single security user.
|
| SecurityPrincipals | Interface for an editable collection of SecurityPrincipal objects. .NET only.
|
| SecurityUser | A single security user.
|
| SecurityUsers | Collection of SecurityUser objects in a Security object of a Database.
|
| SecurityUsersArray | Read-only collection of SecurityUser objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| SecurityUsersCollection | Collection of SecurityUser objects.
|
| Server | Object representation of an OLAP Server.
|
| Servers | Editable collection of Server objects.
|
| ServersArray | Read-only collection of Server objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| Slice | Object representation of a Slice.
|
| SliceAccessRightGroup | Grouping of security objects relating a SecurityGroup to a Slice.
|
| SliceAccessRightGroups | Collection of SliceAccessRightGroup objects in a Security object of a Database.
|
| SliceAccessRightGroupsArray | Read-only collection of SliceAccessRightGroup objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| SliceDimension | .NET Only. Dimension used in a Slice.
|
| SliceDimensions | Editable collection of SliceDimension objects.
|
| SliceDimensionsArray | Read-only collection of SliceDimension objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| Slices | Editable collection of Slice objects.
|
| SlicesArray | Read-only collection of Slice objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| SlicingCondition | .NET Only. Collection of Slice Dimensions on the page of a Slice.
|
| Subset | Object representation of a Subset.
|
| Subsets | Editable collection of Subset objects.
|
| SubsetsArray | Read-only collection of Subset objects. This documentation is incomplete as this interface also implements the members of IArray<(Of <(T>)>).
|
| TransferCubeInfo | Full set of parameters for a Cube transfer.
|
| Tuple | Collection describing the horizontal or vertical segment of a slice. Members collection includes one mmeber from each dimension along the Axis.
|
| TypeHelper | Used to help manipulate the Tuple class.
|
| UserSession | A UserSession on a Server.
|
| UserSessionsArray | Read-only collection of UserSession objects.
|
| UserThreadInfo | Information about a user responsible for a running thread.
|
| UserThreadInfosArray | Read-only collection of UserThreadInfo objects.
|
| Value | Specification of a point in a slice.
|
| ValueInfo | Meta information about a FactValue.
|
| Values | Read only collection of Value objects.
|
| XmlExportMetaDataInfo | Parameters for ExportMetaData method. Result from a call to PrepareXmlExportMetaDataParam.
|
| XmlImportMetaDataInfo | Parameters for ImportMetaData method. Result from a call to PrepareXmlImportMetaDataParam.
|
Delegates
| Delegate | Description | |
|---|---|---|
 | CanContinueOperationCallback | Callback used to cancel a server import/export process. .NET Only.
|
| CloseDatabaseHandler | |
| NotifyCollectionHandler | .NET Only. Delegate fired when the collection is changed.
|
| NotifyCollectionHandler<(Of <(ARRAY>)>) | .NET Only. Delegate fired when the collection is changed.
|
| NotifyObjectHandler | .NET Only. Delegate fired when the object is changed.
|
Enumerations
| Enumeration | Description | |
|---|---|---|
 | AxisType | Indicates the location of the dimension in the slice.
|
| CacheLevel | .NET Only. Used for specifying cache level.
|
| CubeType | Indicates the cube type.
|
| DrillThroughRecordType | Indicates the type of the drill through record.
|
| FactAccess | Indicates access a user has on factdata.
|
| FactDataState | Indicates state of the factdata.
|
| FactValueType | Indicates the type of a factdata value.
|
| ImportDimensionType | Indicates the type of the Dimension being imported.
|
| ImportOperation | Indicates the type of import to perform.
|
| MemberType | Indicates the member type.
|
| MessageSeverity | Indicates the severity of the message.
|
| MetaAccess | Indicates access a user has on a metadata object.
|
| MetaType | Type of metadata object.
|
| PrincipalType | Indicates type of security principal.
|
| Provider | Specifies the data provider for the connection.
|
| SecurityLevel | Indicates security access level in a database.
|
| ServerStatus | Used to indicate status of a proCube instance.
|
| TransferMethod | Indicates the transfer method to sue for the data transfer.
|
