com.essbase.api.datasource

Interface IEssCustomObject

All Superinterfaces:

IEssBaseObject, IEssExtendedObject

All Known Subinterfaces:

IEssCustomObjectDefinition

public interface IEssCustomObject
extends IEssExtendedObject

An object of this interface represents a Essbase Custom Object, that exists for supporting the Oracle Sales Analyzer (OSA) functionality.

A Custom object is associated with the Essbase cube and can be of type: Set, Measure, Aggregate or Grid Layout.

These APIs are supported by Essbase version 11.1.2.3

Since:

11.1.2.3

Version:

1.0

Author:

Balaji Sundaresan

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IEssCustomObject.CustomObjectCopyOption Options available for copying Custom Objects.
static class	IEssCustomObject.CustomObjectType Types of Custom Objects.

Method Summary

Modifier and Type	Method and Description
void	copyTo(java.lang.String destSchema, java.lang.String destName, IEssCustomObject.CustomObjectCopyOption option) Copies this custom object (includes its metadata definition) to specified schema and name.
void	create() Creates this custom object on the on associated Essbase Cube.
void	delete() Deletes this Custom object from associated Essbase cube.
IEssCube	getCube() Returns the Cube instance to which this Custom Object is associated.
com.essbase.api.datasource.EssCustObjDefinition	getDefinition() Gets the custom object metadata definition.
java.lang.String	getName() Returns the Name of the Custom Object.
java.lang.String	getSchemaName() Returns the relation database schema name where this custom object is stored.
IEssCustomObject.CustomObjectType	getType() Returns the type of Custom Object.
boolean	isEditable() Indicates if this custom object is edit-able by the logged-in Essbase user.
void	refresh() On refresh, an instance of this java object will be updated with the latest information of this object from Essbase Server.
void	rename(java.lang.String newName) Renames the existing Custom object in associated Essbase cube.
void	setDefinition(com.essbase.api.datasource.EssCustObjDefinition coDefintion) Sets the metadata definition information for this custom object.
void	setEditable(boolean editable) To sets if its editable or not.
void	update() Updates this custom object information like defintion, etc on the Essbase server.
void	validate() Validates this existing custom object and its definition in the associated Cube.

Methods inherited from interface com.essbase.api.base.IEssExtendedObject

clearClientCache, getParent, getParentBase, isClientCachingEnabled, setClientCachingEnabled

Method Detail

getName

java.lang.String getName()

Returns the Name of the Custom Object.

Specified by:

getName in interface IEssExtendedObject

Returns:

Custom object name.

getType

IEssCustomObject.CustomObjectType getType()

Returns the type of Custom Object.

Returns:

Custom Object Type.

See Also:

IEssCustomObject.CustomObjectType

getSchemaName

java.lang.String getSchemaName()

Returns the relation database schema name where this custom object is stored.

Returns:

Schema Name.

getCube

IEssCube getCube()

Returns the Cube instance to which this Custom Object is associated.

Returns:

Cube instance.

create

void create()
     throws com.essbase.api.base.EssException

Creates this custom object on the on associated Essbase Cube. In order to create, the pre-requiste is to set the metadata defintion and other object information using methods {#setDefinition(EssCustObjDefinition), #setEditable(boolean)} etc.

This method requires the user to be a member of the group i.e. the schema specified, else it errors out.

Throws:

com.essbase.api.base.EssException - on failure to create.

See Also:

setDefinition(EssCustObjDefinition)

update

void update()
     throws com.essbase.api.base.EssException

Updates this custom object information like defintion, etc on the Essbase server.

This method requires the user to be a member of the group i.e. the schema specified, else it errors out.

Throws:

com.essbase.api.base.EssException - on failure to update the definition.

delete

void delete()
     throws com.essbase.api.base.EssException

Deletes this Custom object from associated Essbase cube.

This method requires the user to be a member of the group i.e. the schema specified, else it errors out.

Throws:

com.essbase.api.base.EssException - on failure to remove this custom object.

rename

void rename(java.lang.String newName)
     throws com.essbase.api.base.EssException

Renames the existing Custom object in associated Essbase cube.

Parameters:

newName - New name for this custom object.

This method requires the user to be a member of the group i.e. the schema specified, else it errors out.

Throws:

com.essbase.api.base.EssException - on failing to rename.

validate

void validate()
       throws com.essbase.api.base.EssException

Validates this existing custom object and its definition in the associated Cube. If validation succeeds, then no error is thrown. If object is invalid, this would throw EssException with the error information.

The following are the Essbase rules for validating a custom object: 1) Ensures user has access to the schema and the custom object exists. 2) Ensures based on type, appropriate fields are filled. 3) Compiles MDX fragment and verifies dimensionality. If successful, updates the dimensionality in schema-object list mapping. 4) Validates the dependency object list.

Please note that during outline restructure, Essbase does not validate custom objects. It validates custom objects only on a demand basis. So only when custom objects are created, updated or when they are validated, the validity status of the custom objects is updated within. One of the purposes of validating custom object is the outline may have changed by deleting or renaming dimension(s) or member(s), then the custom objects which refer to that dimension(s) or member(s) become invalid.

This method requires the user to be a member of the group i.e. the schema specified, else it errors out.

Throws:

com.essbase.api.base.EssException - if object is in a invalid state, or failing to validate the object.

copyTo

void copyTo(java.lang.String destSchema,
            java.lang.String destName,
            IEssCustomObject.CustomObjectCopyOption option)
     throws com.essbase.api.base.EssException

Copies this custom object (includes its metadata definition) to specified schema and name. It does a deep copy i.e., it copies even the dependent custom objects.

This method requires the user to be a member of both source schema and schema specified, else it errors out.

Parameters:

destSchema - Destination Schema.

destName - Destination Name.

option - type of copying option available in {#IEssCustomObject.CustomObjectType}

Throws:

com.essbase.api.base.EssException - on Error.

See Also:

IEssCustomObject.CustomObjectCopyOption

getDefinition

com.essbase.api.datasource.EssCustObjDefinition getDefinition()
                                                       throws com.essbase.api.base.EssException

Gets the custom object metadata definition.

This method requires the user to be a member of both source schema and schema specified, else it errors out.

Returns:

Metadata definition.

Throws:

com.essbase.api.base.EssException - on failing to get the object definition.

setDefinition

void setDefinition(com.essbase.api.datasource.EssCustObjDefinition coDefintion)
            throws com.essbase.api.base.EssException

Sets the metadata definition information for this custom object. This definition is set only on the object locally and it not set on the Essbase server until create or update operation is performed.

Parameters:

coDefintion - type EssCustObjDefinition

Throws:

com.essbase.api.base.EssException - if an error occurs

isEditable

boolean isEditable()
            throws com.essbase.api.base.EssException

Indicates if this custom object is edit-able by the logged-in Essbase user.

Returns:

true if the custom object is modifiable by this Essbase user.

Throws:

com.essbase.api.base.EssException - on failing to retrieve editable information from Essbase.

setEditable

void setEditable(boolean editable)
          throws com.essbase.api.base.EssException

To sets if its editable or not.

Parameters:

editable - Modify-able.

Throws:

com.essbase.api.base.EssException - on failing to set this state.

refresh

void refresh()
      throws com.essbase.api.base.EssException

On refresh, an instance of this java object will be updated with the latest information of this object from Essbase Server.

Throws:

com.essbase.api.base.EssException - If object is invalid or the operation fails to retrieve data from Essbase.