Skip navigation links


com.essbase.api.dataquery
Interface IEssCubeView

All Superinterfaces:
IEssBaseObject, IEssExtendedObject, IEssProperties

public interface IEssCubeView
extends IEssExtendedObject, IEssProperties

The IEssCubeView interface.

Version:
1.0, 04/04/2001
Author:
Srini Ranga

Nested Class Summary
static class IEssCubeView.EEssIndentStyle
          The EEssIndentStyle is an enumeration of indent styles.
static class IEssCubeView.EEssQueryGrammar
          The EEssQueryGrammar class is an enumeration of query language grammars.

 

Nested classes/interfaces inherited from interface com.essbase.api.base.IEssProperties
IEssProperties.EEssPropertyMode

 

Field Summary
static int PROP_ALIAS_TABLE_NAME
           
static int PROP_CONNECTION_POOL_NAME
           
static int PROP_DESCRIPTION
           
static int PROP_DISPLAY_UNKNOWN_MEMBERS
           
static int PROP_DRILL_LEVEL
           
static int PROP_ENABLE_HYBRID_ANALYSIS
           
static int PROP_INDENT_STYLE
           
static int PROP_IS_ALIAS_NAMES
           
static int PROP_IS_BOTH_MEMBER_AND_UNIQUE_NAME
           
static int PROP_IS_EMPTY_GRID_ERROR
           
static int PROP_IS_ENABLE_DATALESS_NAVIGATION
           
static int PROP_IS_ENABLE_DRILL_THROUGH_CODING
           
static int PROP_IS_ENABLE_DRILL_THROUGH_URL
           
static int PROP_IS_ENABLE_FORMAT_MISSING
           
static int PROP_IS_ENABLE_FORMATTED_VALUES
           
static int PROP_IS_EXTENDED_MEMBER_COMMENTS
           
static int PROP_IS_INCLUDE_SELECTION
           
static int PROP_IS_REPEAT_MEMBER_NAMES
           
static int PROP_IS_SELECTION_ONLY
           
static int PROP_IS_SPECIFY_LATEST_MEMBER
           
static int PROP_IS_SUPPRESS_MISSING
           
static int PROP_IS_SUPPRESS_NUM_VALUES
           
static int PROP_IS_SUPPRESS_UNDERSCORE
           
static int PROP_IS_SUPPRESS_ZERO
           
static int PROP_IS_UNIQUENAME_ONLY
           
static int PROP_IS_USE_BOTH_FOR_ROW_DIMENSIONS
           
static int PROP_IS_WITHIN_SELECTED_GROUP
           
static int PROP_LATEST_MEMBER_NAME
           
static int PROP_MID_TIER_CACHING_ENABLED
           
static int PROP_NAME
           
static int s_countProperties
           
static IEssValueAny.EEssDataType[] s_propDataTypes
           
static IEssProperties.EEssPropertyMode[] s_propModes
           
static java.lang.String[] s_propNames
           

 

Method Summary
 void close()
          Closes the cube view.
 IEssOpCalculate createIEssOpCalculate()
          Creates an object for the interface IEssOpCalculate.
 IEssOpKeepOnly createIEssOpKeepOnly()
          Creates an object for the interface IEssOpKeepOnly.
 IEssOpLock createIEssOpLock()
          Creates an object for the interface IEssOpLock.
 IEssOpMdxQuery createIEssOpMdxQuery()
          Creates an object for the interface IEssOpMdxQuery.
 IEssOpPivot createIEssOpPivot()
          Creates an object for the interface IEssOpPivot.
 IEssOpRemoveOnly createIEssOpRemoveOnly()
          Creates an object for the interface IEssOpRemoveOnly.
 IEssOpReport createIEssOpReport()
          Creates an object for the interface IEssOpReport.
 IEssOpRetrieve createIEssOpRetrieve()
          Creates an object for the interface IEssOpRetrieve.
 IEssOpUndo createIEssOpUndo()
          Creates an object for the interface IEssOpUndo.
 IEssOpUnlock createIEssOpUnlock()
          Creates an object for the interface IEssOpUnlock.
 IEssOpUpdate createIEssOpUpdate()
          Creates an object for the interface IEssOpUpdate.
 IEssOpZoomIn createIEssOpZoomIn()
          Creates an object for the interface IEssOpZoomIn.
 IEssOpZoomOut createIEssOpZoomOut()
          Creates an object for the interface IEssOpZoomOut.
 void emailOutput(java.lang.String to, java.lang.String cc, java.lang.String bcc, java.lang.String subject)
          Deprecated. This feature is deprecated since Release 9.3.0
 java.lang.String getAliasTable()
          Gets the alias table name.
 java.lang.String getConnectionPoolName()
          Gets the name of the connection pool used.
 IEssCube getCube()
          Gets the parent cube.
 java.lang.String getDescription()
          Gets the cube view description.
 IEssOpZoomIn.EEssZoomInPreference getDrillLevel()
          Gets the drill level.
 IEssGridView getGridView()
          Gets the grid view of the cube view.
 java.lang.String getHtmlOutput()
          Gets the HTML view of the output.
 IEssCubeView.EEssIndentStyle getIndentStyle()
          Gets the indent style.
 java.lang.String getLatestMemberName()
          Gets the latest member name.
 IEssMdDataSet getMdDataSet()
          Gets the result after running MDX query operation.
 IEssCustomMessageHandler getMessageHandler()
          Retrieves the custom message handler associated with the session.
 java.lang.String getName()
          Gets the cube view name.
 boolean isAliasNames()
          Checks if alias names.
 boolean isBothMemberAndUniqueName()
          Checks if both member and unique member name will be returned.
 boolean isDatalessNavigation()
          Checks if data less navigation is enabled.
 boolean isDisplayUnknownMembers()
          Checks if to display unknown members in the grid.
 boolean isDrillThroughCoding()
          Checks if Drill Through Coding is to be enabled during retrieve.
 boolean isEmptyGridError()
          Checks if to error on empty grid.
 boolean isExtendedMemberComment()
          Checks if Extended Member Comments is to be retrieved during operations.
 boolean isFormatMissing()
          Deprecated. Replaced by isProcessMissing()
 boolean isFormattedValues()
          Checks if formatted values is to be retrieved during operation.
 boolean isHybridAnalysisEnabled()
          Checks if hybrid analysis is enabled.
 boolean isIncludeSelection()
          Checks if to include selection.
 boolean isMeaningless()
          Indicates if the grid operation needs to return Meaningless cells, if any.
 boolean isMidTierCachingEnabled()
          Checks if mid-tier caching is enabled.
 boolean isProcessMissing()
          Indicates if the Missing cells are to be color coded/formatted.
 boolean isRepeatMemberNames()
          Checks if to repeat member names.
 boolean isSelectionOnly()
          Checks if selection only.
 boolean isSpecifyLatestMember()
          Checks if to specify latest member.
 boolean isSuppressMissing()
          Checks if suppress missing.
 boolean isSuppressNumValues()
          Checks if numeric values is to be suppressed during operation.
 boolean isSuppressUnderscore()
          Checks if suppress underscore.
 boolean isSuppressZero()
          Checks if suppress zero.
 boolean isUniqueNameOnly()
          Checks if only unique member names will be returned.
 boolean isURLDrillThrough()
          Returns if option for retrieving of URL drill through information is enabled or not.
 boolean isUseBothForRowDimensions()
          Checks if to use both for row dimensions.
 boolean isWithinSelectedGroup()
          Checks if within selected group.
 IEssMember[] memberSelection(java.lang.String mbrName, int queryType, int queryOptions, java.lang.String dimName, java.lang.String input1, java.lang.String input2)
          Performs member selection.
 IEssMember[] memberSelection(java.lang.String mbrSel, java.lang.String fldSel)
          Performs member selection.
 void performOperation(IEssOperation operation)
          Performs an operation on the cube view.
 void refreshPropertyValues()
          Refreshes the property values.
 void save()
          Saves the cube view to the domain store with the current name.
 void save(java.lang.String cubeViewName)
          Saves the cube view to the domain store with the new name.
 void setAliasNames(boolean aliasNames)
          Sets if alias names.
 void setAliasTable(java.lang.String aliasTableName)
          Sets the alias table name.
 void setBothMemberAndUniqueName(boolean bothMemberAnduniqueName)
          Sets if both member and unique member names will be returned.
 void setDatalessNavigation(boolean datalessNavigation)
          Sets if data less navigation is enabled.
 void setDescription(java.lang.String description)
          Sets the cube view description.
 void setDisplayUnknownMembers(boolean dispUnknown)
          Sets if to display unknown members in the grid.
 void setDrillLevel(IEssOpZoomIn.EEssZoomInPreference drillLevel)
          Sets the drill level.
 void setDrillThroughCoding(boolean dtCoding)
          Set if drill through coding is to be enabled during retrieve.
 void setEmptyGridError(boolean emptyGridError)
          Sets if to error on empty grid.
 void setExtendedMemberComment(boolean EMC)
          Set if Extended Member Comments(EMC) is to retrieved.
 void setFormatMissing(boolean formatMissing)
          Deprecated. Replaced by setProcessMissing(boolean)
 void setFormattedValues(boolean formattedValues)
          Set if formatted values is to retrieved.
 void setHybridAnalysisEnabled(boolean enableHa)
          Sets if hybrid analysis is enabled.
 void setIncludeSelection(boolean includeSelection)
          Sets to include selection.
 void setIndentStyle(IEssCubeView.EEssIndentStyle indentStyle)
          Sets the indent style.
 void setLatestMemberName(java.lang.String latestMemberName)
          Sets the latest member name.
 void setMeaningless(boolean enableMeaninglessCells)
          To enable to disable viewing Meaningless cells in the grid result.
 void setMessageHandler(IEssCustomMessageHandler handler)
          Associates the Custom message handler to the session.
 void setMidTierCachingEnabled(boolean midTierCachingEnabled)
          Sets if mid-tier caching is enabled.
 void setProcessMissing(boolean processMissing)
          Set if URL color coding or formatting of MISSING cells is to be performed.
 void setRepeatMemberNames(boolean repeatMemberNames)
          Sets to repeat member names.
 void setSelectionOnly(boolean selectionOnly)
          Sets if selection only.
 void setSpecifyLatestMember(boolean specifyLatestMember)
          Sets if to specify latest member.
 void setSuppressMissing(boolean suppressMissing)
          Sets if suppress missing.
 void setSuppressNumValues(boolean suppressNumValues)
          Set if numeric values for the Smartlist, Formatted Strings or Date is to suppressed.
 void setSuppressUnderscore(boolean suppUnderscore)
          Sets if suppress underscore.
 void setSuppressZero(boolean suppressZero)
          Sets if suppress zero.
 void setUniqueNameOnly(boolean uniqueNameOnly)
          Sets if only unique member names will be returned.
 void setURLDrillThrough(boolean enable)
          To enable or disable retrieving of URL drill through information.
 void setUseBothForRowDimensions(boolean useBothForRowDimensions)
          Sets if to use both for row dimensions.
 void setWithinSelectedGroup(boolean withinSelectedGroup)
          Sets if within selected group.
 void updatePropertyValues()
          Updates the property values.

 

Methods inherited from interface com.essbase.api.base.IEssExtendedObject
clearClientCache, getParent, getParentBase, isClientCachingEnabled, setClientCachingEnabled

 

Methods inherited from interface com.essbase.api.base.IEssProperties
getCountProperties, getPropertyDataType, getPropertyDataType, getPropertyDataTypes, getPropertyId, getPropertyMode, getPropertyMode, getPropertyModes, getPropertyName, getPropertyNames, getPropertyValueAny, getPropertyValueAny, setPropertyValueAny, setPropertyValueAny

 

Field Detail

PROP_NAME

static final int PROP_NAME
See Also:
Constant Field Values

PROP_DESCRIPTION

static final int PROP_DESCRIPTION
See Also:
Constant Field Values

PROP_DRILL_LEVEL

static final int PROP_DRILL_LEVEL
See Also:
Constant Field Values

PROP_IS_INCLUDE_SELECTION

static final int PROP_IS_INCLUDE_SELECTION
See Also:
Constant Field Values

PROP_IS_SELECTION_ONLY

static final int PROP_IS_SELECTION_ONLY
See Also:
Constant Field Values

PROP_IS_WITHIN_SELECTED_GROUP

static final int PROP_IS_WITHIN_SELECTED_GROUP
See Also:
Constant Field Values

PROP_INDENT_STYLE

static final int PROP_INDENT_STYLE
See Also:
Constant Field Values

PROP_IS_SUPPRESS_MISSING

static final int PROP_IS_SUPPRESS_MISSING
See Also:
Constant Field Values

PROP_IS_SUPPRESS_ZERO

static final int PROP_IS_SUPPRESS_ZERO
See Also:
Constant Field Values

PROP_IS_SUPPRESS_UNDERSCORE

static final int PROP_IS_SUPPRESS_UNDERSCORE
See Also:
Constant Field Values

PROP_IS_ALIAS_NAMES

static final int PROP_IS_ALIAS_NAMES
See Also:
Constant Field Values

PROP_ALIAS_TABLE_NAME

static final int PROP_ALIAS_TABLE_NAME
See Also:
Constant Field Values

PROP_IS_ENABLE_DATALESS_NAVIGATION

static final int PROP_IS_ENABLE_DATALESS_NAVIGATION
See Also:
Constant Field Values

PROP_IS_EMPTY_GRID_ERROR

static final int PROP_IS_EMPTY_GRID_ERROR
See Also:
Constant Field Values

PROP_IS_REPEAT_MEMBER_NAMES

static final int PROP_IS_REPEAT_MEMBER_NAMES
See Also:
Constant Field Values

PROP_IS_USE_BOTH_FOR_ROW_DIMENSIONS

static final int PROP_IS_USE_BOTH_FOR_ROW_DIMENSIONS
See Also:
Constant Field Values

PROP_IS_SPECIFY_LATEST_MEMBER

static final int PROP_IS_SPECIFY_LATEST_MEMBER
See Also:
Constant Field Values

PROP_LATEST_MEMBER_NAME

static final int PROP_LATEST_MEMBER_NAME
See Also:
Constant Field Values

PROP_MID_TIER_CACHING_ENABLED

static final int PROP_MID_TIER_CACHING_ENABLED
See Also:
Constant Field Values

PROP_CONNECTION_POOL_NAME

static final int PROP_CONNECTION_POOL_NAME
See Also:
Constant Field Values

PROP_ENABLE_HYBRID_ANALYSIS

static final int PROP_ENABLE_HYBRID_ANALYSIS
See Also:
Constant Field Values

PROP_DISPLAY_UNKNOWN_MEMBERS

static final int PROP_DISPLAY_UNKNOWN_MEMBERS
See Also:
Constant Field Values

PROP_IS_UNIQUENAME_ONLY

static final int PROP_IS_UNIQUENAME_ONLY
See Also:
Constant Field Values

PROP_IS_BOTH_MEMBER_AND_UNIQUE_NAME

static final int PROP_IS_BOTH_MEMBER_AND_UNIQUE_NAME
See Also:
Constant Field Values

PROP_IS_EXTENDED_MEMBER_COMMENTS

static final int PROP_IS_EXTENDED_MEMBER_COMMENTS
See Also:
Constant Field Values

PROP_IS_SUPPRESS_NUM_VALUES

static final int PROP_IS_SUPPRESS_NUM_VALUES
See Also:
Constant Field Values

PROP_IS_ENABLE_FORMATTED_VALUES

static final int PROP_IS_ENABLE_FORMATTED_VALUES
See Also:
Constant Field Values

PROP_IS_ENABLE_FORMAT_MISSING

static final int PROP_IS_ENABLE_FORMAT_MISSING
See Also:
Constant Field Values

PROP_IS_ENABLE_DRILL_THROUGH_CODING

static final int PROP_IS_ENABLE_DRILL_THROUGH_CODING
See Also:
Constant Field Values

PROP_IS_ENABLE_DRILL_THROUGH_URL

static final int PROP_IS_ENABLE_DRILL_THROUGH_URL
See Also:
Constant Field Values

s_countProperties

static final int s_countProperties
See Also:
Constant Field Values

s_propNames

static final java.lang.String[] s_propNames

s_propDataTypes

static final IEssValueAny.EEssDataType[] s_propDataTypes

s_propModes

static final IEssProperties.EEssPropertyMode[] s_propModes

Method Detail

getName

java.lang.String getName()
                         throws com.essbase.api.base.EssException
Gets the cube view name.
Specified by:
getName in interface IEssExtendedObject
Returns:
The cube view name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDescription

java.lang.String getDescription()
                                throws com.essbase.api.base.EssException
Gets the cube view description.
Returns:
The cube view description.
Throws:
com.essbase.api.base.EssException - if an error occurs.
See Also:
refreshPropertyValues()

setDescription

void setDescription(java.lang.String description)
                    throws com.essbase.api.base.EssException
Sets the cube view description. The change will become effective after you invoke updatePropertyValues().
Parameters:
description - The cube view description.
Throws:
com.essbase.api.base.EssException - if an error occurs.
See Also:
updatePropertyValues()

getDrillLevel

IEssOpZoomIn.EEssZoomInPreference getDrillLevel()
                                                throws com.essbase.api.base.EssException
Gets the drill level.
Returns:
The drill level (i.e zoom in preference).
Throws:
com.essbase.api.base.EssException - if an error occurs.

setDrillLevel

void setDrillLevel(IEssOpZoomIn.EEssZoomInPreference drillLevel)
                   throws com.essbase.api.base.EssException
Sets the drill level. The change will become effective after you invoke updatePropertyValues().
Parameters:
drillLevel - The drill level (i.e zoom in preference).
Throws:
com.essbase.api.base.EssException - if an error occurs.

isIncludeSelection

boolean isIncludeSelection()
                           throws com.essbase.api.base.EssException
Checks if to include selection.
Returns:
true if to include selection.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setIncludeSelection

void setIncludeSelection(boolean includeSelection)
                         throws com.essbase.api.base.EssException
Sets to include selection. The change will become effective after you invoke updatePropertyValues().
Parameters:
includeSelection - true if to include selection.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isSelectionOnly

boolean isSelectionOnly()
                        throws com.essbase.api.base.EssException
Checks if selection only.
Returns:
true if selection only.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setSelectionOnly

void setSelectionOnly(boolean selectionOnly)
                      throws com.essbase.api.base.EssException
Sets if selection only. The change will become effective after you invoke updatePropertyValues().
Parameters:
selectionOnly - true if selection only.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isWithinSelectedGroup

boolean isWithinSelectedGroup()
                              throws com.essbase.api.base.EssException
Checks if within selected group.
Returns:
true if within selected group.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setWithinSelectedGroup

void setWithinSelectedGroup(boolean withinSelectedGroup)
                            throws com.essbase.api.base.EssException
Sets if within selected group. The change will become effective after you invoke updatePropertyValues().
Parameters:
withinSelectedGroup - true if within selected group.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getIndentStyle

IEssCubeView.EEssIndentStyle getIndentStyle()
                                            throws com.essbase.api.base.EssException
Gets the indent style.
Returns:
The indent style.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setIndentStyle

void setIndentStyle(IEssCubeView.EEssIndentStyle indentStyle)
                    throws com.essbase.api.base.EssException
Sets the indent style. The change will become effective after you invoke updatePropertyValues().
Parameters:
indentStyle - The indent style.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isSuppressMissing

boolean isSuppressMissing()
                          throws com.essbase.api.base.EssException
Checks if suppress missing.
Returns:
true if suppress missing.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setSuppressMissing

void setSuppressMissing(boolean suppressMissing)
                        throws com.essbase.api.base.EssException
Sets if suppress missing. The change will become effective after you invoke updatePropertyValues().
Parameters:
suppressMissing - true if suppress missing.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isSuppressZero

boolean isSuppressZero()
                       throws com.essbase.api.base.EssException
Checks if suppress zero.
Returns:
true if suppress zero.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setSuppressZero

void setSuppressZero(boolean suppressZero)
                     throws com.essbase.api.base.EssException
Sets if suppress zero. The change will become effective after you invoke updatePropertyValues().
Parameters:
suppressZero - true if suppress zero.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isSuppressUnderscore

boolean isSuppressUnderscore()
                             throws com.essbase.api.base.EssException
Checks if suppress underscore.
Returns:
true if suppress underscore.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setSuppressUnderscore

void setSuppressUnderscore(boolean suppUnderscore)
                           throws com.essbase.api.base.EssException
Sets if suppress underscore. The change will become effective after you invoke updatePropertyValues().
Parameters:
suppUnderscore - true if suppress underscore.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isAliasNames

boolean isAliasNames()
                     throws com.essbase.api.base.EssException
Checks if alias names.
Returns:
true if alias names.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setAliasNames

void setAliasNames(boolean aliasNames)
                   throws com.essbase.api.base.EssException
Sets if alias names. The change will become effective after you invoke updatePropertyValues().
Parameters:
aliasNames - true if alias names.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getAliasTable

java.lang.String getAliasTable()
                               throws com.essbase.api.base.EssException
Gets the alias table name.
Returns:
The alias table name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setAliasTable

void setAliasTable(java.lang.String aliasTableName)
                   throws com.essbase.api.base.EssException
Sets the alias table name. The change will become effective after you invoke updatePropertyValues().
Parameters:
aliasTableName - The alias table name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isDatalessNavigation

boolean isDatalessNavigation()
                             throws com.essbase.api.base.EssException
Checks if data less navigation is enabled.
Returns:
true if data less navigation.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setDatalessNavigation

void setDatalessNavigation(boolean datalessNavigation)
                           throws com.essbase.api.base.EssException
Sets if data less navigation is enabled. The change will become effective after you invoke updatePropertyValues().
Parameters:
datalessNavigation - true if data less navigation.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isEmptyGridError

boolean isEmptyGridError()
                         throws com.essbase.api.base.EssException
Checks if to error on empty grid.
Returns:
true if to error on empty grid.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setEmptyGridError

void setEmptyGridError(boolean emptyGridError)
                       throws com.essbase.api.base.EssException
Sets if to error on empty grid. The change will become effective after you invoke updatePropertyValues().
Parameters:
emptyGridError - Error on empty grid.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isRepeatMemberNames

boolean isRepeatMemberNames()
                            throws com.essbase.api.base.EssException
Checks if to repeat member names.
Returns:
true if to repeat member names.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setRepeatMemberNames

void setRepeatMemberNames(boolean repeatMemberNames)
                          throws com.essbase.api.base.EssException
Sets to repeat member names. This property is set to true by default since release 11.1.1 . If it is set to false, the BPM Drill Through functionality may not work as intended. The change will become effective after you invoke updatePropertyValues().
Throws:
com.essbase.api.base.EssException - if an error occurs.

isUseBothForRowDimensions

boolean isUseBothForRowDimensions()
                                  throws com.essbase.api.base.EssException
Checks if to use both for row dimensions.
Returns:
true if to use both for row dimensions.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setUseBothForRowDimensions

void setUseBothForRowDimensions(boolean useBothForRowDimensions)
                                throws com.essbase.api.base.EssException
Sets if to use both for row dimensions. The change will become effective after you invoke updatePropertyValues().
Parameters:
useBothForRowDimensions - true to use both for row dimensions
Throws:
com.essbase.api.base.EssException - if an error occurs.

isSpecifyLatestMember

boolean isSpecifyLatestMember()
                              throws com.essbase.api.base.EssException
Checks if to specify latest member.
Returns:
true if to specify latest member.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setSpecifyLatestMember

void setSpecifyLatestMember(boolean specifyLatestMember)
                            throws com.essbase.api.base.EssException
Sets if to specify latest member. The change will become effective after you invoke updatePropertyValues().
Parameters:
specifyLatestMember - true to specify latest member.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getLatestMemberName

java.lang.String getLatestMemberName()
                                     throws com.essbase.api.base.EssException
Gets the latest member name.
Returns:
The latest member name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setLatestMemberName

void setLatestMemberName(java.lang.String latestMemberName)
                         throws com.essbase.api.base.EssException
Sets the latest member name. The change will become effective after you invoke updatePropertyValues().
Parameters:
latestMemberName - The latest member name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isMidTierCachingEnabled

boolean isMidTierCachingEnabled()
                                throws com.essbase.api.base.EssException
Checks if mid-tier caching is enabled.
Returns:
true if mid-tier caching is enabled.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setMidTierCachingEnabled

void setMidTierCachingEnabled(boolean midTierCachingEnabled)
                              throws com.essbase.api.base.EssException
Sets if mid-tier caching is enabled. It it is enabled and if the grid returned by the previous operation is not changed on the client then the grid will not be sent from the client to EDS server for the next operation. The EDS server caches the previous grid and uses it for the next operation in this case. The change will become effective after you invoke updatePropertyValues().
Parameters:
midTierCachingEnabled - true to enable mid-tier caching.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getConnectionPoolName

java.lang.String getConnectionPoolName()
                                       throws com.essbase.api.base.EssException
Gets the name of the connection pool used.
Returns:
The name of the connection pool.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isHybridAnalysisEnabled

boolean isHybridAnalysisEnabled()
                                throws com.essbase.api.base.EssException
Checks if hybrid analysis is enabled.
Returns:
true if hybrid analysis is enabled.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setHybridAnalysisEnabled

void setHybridAnalysisEnabled(boolean enableHa)
                              throws com.essbase.api.base.EssException
Sets if hybrid analysis is enabled. The default value is false. The change will become effective after you invoke updatePropertyValues().
Parameters:
enableHa - true to enable hybrid analysis.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isDisplayUnknownMembers

boolean isDisplayUnknownMembers()
                                throws com.essbase.api.base.EssException
Checks if to display unknown members in the grid.
Returns:
true if unknown members will be displayed.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setDisplayUnknownMembers

void setDisplayUnknownMembers(boolean dispUnknown)
                              throws com.essbase.api.base.EssException
Sets if to display unknown members in the grid. The change will become effective after you invoke updatePropertyValues().
Parameters:
dispUnknown - true to display unknown members.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isUniqueNameOnly

boolean isUniqueNameOnly()
                         throws com.essbase.api.base.EssException
Checks if only unique member names will be returned.
Returns:
true if unique member names only.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setUniqueNameOnly

void setUniqueNameOnly(boolean uniqueNameOnly)
                       throws com.essbase.api.base.EssException
Sets if only unique member names will be returned. The change will become effective after you invoke updatePropertyValues().
Parameters:
uniqueNameOnly - true if unique member names only are to be returned.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isBothMemberAndUniqueName

boolean isBothMemberAndUniqueName()
                                  throws com.essbase.api.base.EssException
Checks if both member and unique member name will be returned.
Returns:
true if both member and unique name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setBothMemberAndUniqueName

void setBothMemberAndUniqueName(boolean bothMemberAnduniqueName)
                                throws com.essbase.api.base.EssException
Sets if both member and unique member names will be returned. The change will become effective after you invoke updatePropertyValues().
Parameters:
bothMemberAnduniqueName - true if both member and unique member name are to be returned.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setExtendedMemberComment

void setExtendedMemberComment(boolean EMC)
                              throws com.essbase.api.base.EssException
Set if Extended Member Comments(EMC) is to retrieved.
Parameters:
EMC -
Throws:
com.essbase.api.base.EssException

isExtendedMemberComment

boolean isExtendedMemberComment()
                                throws com.essbase.api.base.EssException
Checks if Extended Member Comments is to be retrieved during operations.
Returns:
- boolean, EMC
Throws:
com.essbase.api.base.EssException

isFormattedValues

boolean isFormattedValues()
                          throws com.essbase.api.base.EssException
Checks if formatted values is to be retrieved during operation.
Returns:
true if formatted values is retrieved.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.1.0.0

setFormattedValues

void setFormattedValues(boolean formattedValues)
                        throws com.essbase.api.base.EssException
Set if formatted values is to retrieved.

If Set, the formatted values for the Smartlist, Formatted Strings and Date will be retrieved. and they can be accessed through IEssGrdView.getFormattedValues(row, column) or IEssGridView.getValues(row, column).

Parameters:
formattedValues - true is formatted values is to be fetched.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.1.0.0

isSuppressNumValues

boolean isSuppressNumValues()
                            throws com.essbase.api.base.EssException
Checks if numeric values is to be suppressed during operation.
Returns:
true if numeric values is suppressed.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.1.0.0

setSuppressNumValues

void setSuppressNumValues(boolean suppressNumValues)
                          throws com.essbase.api.base.EssException
Set if numeric values for the Smartlist, Formatted Strings or Date is to suppressed. If set true, the numeric values will not be retrieved.
Parameters:
suppressNumValues - true if the numeric values are to be suppressed.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.1.0.0

isFormatMissing

boolean isFormatMissing()
                        throws com.essbase.api.base.EssException
Deprecated. Replaced by isProcessMissing()
Indicates if the Missing cells have formatted or not.
Returns:
true if Formatting of missing cells is enabled.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.1.0.0

setFormatMissing

void setFormatMissing(boolean formatMissing)
                      throws com.essbase.api.base.EssException
Deprecated. Replaced by setProcessMissing(boolean)
Set if formatting of MISSING cells is to be performed. This is applicable for Smartlist, Date and Formatted String based cells. If set true, returns formatted missing text values.
Parameters:
formatMissing - true if the missing cells are to be formatted.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.1.0.0

isProcessMissing

boolean isProcessMissing()
                         throws com.essbase.api.base.EssException
Indicates if the Missing cells are to be color coded/formatted.
Returns:
true if URL DT color coding/Formatting of missing cells is enabled.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.1.3.0

setProcessMissing

void setProcessMissing(boolean processMissing)
                       throws com.essbase.api.base.EssException
Set if URL color coding or formatting of MISSING cells is to be performed. This is applicable for URL Drill Through, Smartlist, Date and Formatted String based cells. If set true, applies URL color coding/formatting for missing cells as well. The change will be effective after updatePropertyValues() is invoked.
Parameters:
processMissing - true if the missing cells are to be color coded/formatted.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.1.3.0

isMeaningless

boolean isMeaningless()
                      throws com.essbase.api.base.EssException
Indicates if the grid operation needs to return Meaningless cells, if any.

This operation is supported on Essbase version 11.1.1.0.00 and above.

Returns:
true if meaningless cells are to be indicated in the grid result.
Throws:
com.essbase.api.base.EssException - on failing to fetch this information.
Since:
TODO-ClassinAddinParityRelease

setMeaningless

void setMeaningless(boolean enableMeaninglessCells)
                    throws com.essbase.api.base.EssException
To enable to disable viewing Meaningless cells in the grid result.

This operation is supported on Essbase version 11.1.1.0.00 and above.

Parameters:
enableMeaninglessCells - enable Meaningless cells option.
Throws:
com.essbase.api.base.EssException - on failure to set this option on the server.
Since:
TODO-ClassinAddinParityRelease

isDrillThroughCoding

boolean isDrillThroughCoding()
                             throws com.essbase.api.base.EssException
Checks if Drill Through Coding is to be enabled during retrieve.
Returns:
true if drill through coding is enabled.
Throws:
com.essbase.api.base.EssException
Since:
11.1.1.0.0

setDrillThroughCoding

void setDrillThroughCoding(boolean dtCoding)
                           throws com.essbase.api.base.EssException
Set if drill through coding is to be enabled during retrieve. If set true, the DT coding will be enabled i.e. the cells having drill through reports associated with them will be marked. Cell can be checked for the associated drill through reports using IEssMemberCell.isDrillThrough() or IEssDataCell.isDrillThrough(). The change will become effective after you invoke updatePropertyValues(). By default #Missing cells will not be color coded. Invoke setProcessMissing(boolean) if color code is required for #Missing cells as well.
Parameters:
dtCoding -
Throws:
com.essbase.api.base.EssException
Since:
11.1.1.0.0

isURLDrillThrough

boolean isURLDrillThrough()
                          throws com.essbase.api.base.EssException
Returns if option for retrieving of URL drill through information is enabled or not.
Returns:
true if color coding is enabled, else false
Throws:
com.essbase.api.base.EssException - If an Error Occurs
Since:
11.1.1.3

setURLDrillThrough

void setURLDrillThrough(boolean enable)
                        throws com.essbase.api.base.EssException
To enable or disable retrieving of URL drill through information. The change will become effective after you invoke updatePropertyValues().

By default, this option is not set for querying. Cells can check for associated URL drill reports using IEssDataCell.isURLDrillThrough().

Parameters:
enable -
Throws:
com.essbase.api.base.EssException - If an error occurs.
Since:
11.1.1.3

updatePropertyValues

void updatePropertyValues()
                          throws com.essbase.api.base.EssException
Updates the property values. The changes made to this object via setXXX() methods will become effective only after you invoke updatePropertyValues(). If you have opened the cube view with the option of connection per operation, this method will be executed only during the next perform operation.
Specified by:
updatePropertyValues in interface IEssProperties
Throws:
com.essbase.api.base.EssException - if an error occurs.

refreshPropertyValues

void refreshPropertyValues()
                           throws com.essbase.api.base.EssException
Refreshes the property values. The JAPI cache for this object is refreshed with the latest values from the server, so that all the getXXX() methods will return the latest values.
Specified by:
refreshPropertyValues in interface IEssProperties
Throws:
com.essbase.api.base.EssException - if an error occurs.

performOperation

void performOperation(IEssOperation operation)
                      throws com.essbase.api.base.EssException
Performs an operation on the cube view.
Parameters:
operation - The operation.
Throws:
com.essbase.api.base.EssException - if an error occurs.

memberSelection

IEssMember[] memberSelection(java.lang.String mbrSel,
                             java.lang.String fldSel)
                             throws com.essbase.api.base.EssException
Performs member selection. The parameters are described in IEssMemberSelection.executeQuery( String fieldSelection, String mbrSelection) documentation. Note: For IEssMember object obtained using IEssCubeView.memberSelection, only the following methods can be used from IEssMember: getName(), isDimensionRootMember(), getLevelNumber(), getGenerationNumber(), getUnaryConsolidationType(), getDimensionName(), getParentMemberName(), getFirstChildMemberName(), getPreviousSiblingMemberName(), getNextSiblingMemberName(), getMemberNumber(), getDimensionNumber(). The rest of the methods in IEssMember will throw an exception.
Throws:
com.essbase.api.base.EssException

memberSelection

IEssMember[] memberSelection(java.lang.String mbrName,
                             int queryType,
                             int queryOptions,
                             java.lang.String dimName,
                             java.lang.String input1,
                             java.lang.String input2)
                             throws com.essbase.api.base.EssException
Performs member selection. The parameters are described in IEssMemberSelection.executeQuery( String mbrName, int queryType, int queryOptions, String dimName, String input1, String input) documentation. Some of the properties of the member objects obtained through this method will not pe populated: e.g. getParentMemberName, getFirstChildMemberName, getPreviousSiblingMemberName, getNextSiblingMemberName, getMemberNumber, getDimensionNumber will not be populated. Use memberSelection(String mbrSel, String fldSel) for those or use IEssMemberSelection interface to query the members.
Throws:
com.essbase.api.base.EssException

getGridView

IEssGridView getGridView()
                         throws com.essbase.api.base.EssException
Gets the grid view of the cube view.
Returns:
The grid view.
Throws:
com.essbase.api.base.EssException - if an error occurs.

emailOutput

void emailOutput(java.lang.String to,
                 java.lang.String cc,
                 java.lang.String bcc,
                 java.lang.String subject)
                 throws com.essbase.api.base.EssException
Deprecated. This feature is deprecated since Release 9.3.0
Send an e-mail of the output to the specified recipients.
Parameters:
to - To recipient names.
cc - Cc receipient names.
subject - The subject for the message.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getHtmlOutput

java.lang.String getHtmlOutput()
                               throws com.essbase.api.base.EssException
Gets the HTML view of the output.
Returns:
The HTML view of the output.
Throws:
com.essbase.api.base.EssException - if an error occurs.

save

void save()
          throws com.essbase.api.base.EssException
Saves the cube view to the domain store with the current name. (FUTURE USE ONLY)
Throws:
com.essbase.api.base.EssException - if an error occurs.

save

void save(java.lang.String cubeViewName)
          throws com.essbase.api.base.EssException
Saves the cube view to the domain store with the new name. (FUTURE USE ONLY)
Parameters:
cubeViewName - The name of the cube view.
Throws:
com.essbase.api.base.EssException - if an error occurs.

close

void close()
           throws com.essbase.api.base.EssException
Closes the cube view.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createIEssOpZoomIn

IEssOpZoomIn createIEssOpZoomIn()
                                throws com.essbase.api.base.EssException
Creates an object for the interface IEssOpZoomIn.
Returns:
The zoom in operation object.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createIEssOpZoomOut

IEssOpZoomOut createIEssOpZoomOut()
                                  throws com.essbase.api.base.EssException
Creates an object for the interface IEssOpZoomOut.
Returns:
The zoom out operation object.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createIEssOpPivot

IEssOpPivot createIEssOpPivot()
                              throws com.essbase.api.base.EssException
Creates an object for the interface IEssOpPivot.
Returns:
The pivot operation object.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createIEssOpKeepOnly

IEssOpKeepOnly createIEssOpKeepOnly()
                                    throws com.essbase.api.base.EssException
Creates an object for the interface IEssOpKeepOnly.
Returns:
The keep only operation object.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createIEssOpRemoveOnly

IEssOpRemoveOnly createIEssOpRemoveOnly()
                                        throws com.essbase.api.base.EssException
Creates an object for the interface IEssOpRemoveOnly.
Returns:
The remove only operation object.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createIEssOpRetrieve

IEssOpRetrieve createIEssOpRetrieve()
                                    throws com.essbase.api.base.EssException
Creates an object for the interface IEssOpRetrieve.
Returns:
The retrieve operation object.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createIEssOpMdxQuery

IEssOpMdxQuery createIEssOpMdxQuery()
                                    throws com.essbase.api.base.EssException
Creates an object for the interface IEssOpMdxQuery.
Returns:
The MDX query operation object.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createIEssOpReport

IEssOpReport createIEssOpReport()
                                throws com.essbase.api.base.EssException
Creates an object for the interface IEssOpReport.
Returns:
The report operation object.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createIEssOpLock

IEssOpLock createIEssOpLock()
                            throws com.essbase.api.base.EssException
Creates an object for the interface IEssOpLock.
Returns:
The lock operation object.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createIEssOpUnlock

IEssOpUnlock createIEssOpUnlock()
                                throws com.essbase.api.base.EssException
Creates an object for the interface IEssOpUnlock.
Returns:
The unlock operation object.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createIEssOpUpdate

IEssOpUpdate createIEssOpUpdate()
                                throws com.essbase.api.base.EssException
Creates an object for the interface IEssOpUpdate.
Returns:
The update operation object.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createIEssOpUndo

IEssOpUndo createIEssOpUndo()
                            throws com.essbase.api.base.EssException
Creates an object for the interface IEssOpUndo.
Returns:
The undo operation object.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createIEssOpCalculate

IEssOpCalculate createIEssOpCalculate()
                                      throws com.essbase.api.base.EssException
Creates an object for the interface IEssOpCalculate.
Returns:
The calculate operation object.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getMdDataSet

IEssMdDataSet getMdDataSet()
                           throws com.essbase.api.base.EssException
Gets the result after running MDX query operation. This function should only be called after performing MDX query operation using IEssOpMdxQuery otherwise it will return null.
Returns:
The IEssMdDataSet instance.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCube

IEssCube getCube()
                 throws com.essbase.api.base.EssException
Gets the parent cube. This method cannot be used if this cube view object is obtained using openCubeView method in the IEssDomain interface. This method can only be used if this cube view object is obtained using openCubeView method in the IEssCube interface.
Returns:
The parent cube.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setMessageHandler

void setMessageHandler(IEssCustomMessageHandler handler)
                       throws com.essbase.api.base.EssException
Associates the Custom message handler to the session. The API includes a mechanism for intercepting error messages and other messages generated at the server and for displaying the appropriate messages automatically on the client program's screen. This mechanism, although generally useful, can be turned on if desired. The API allows your program to prevent those messages from appearing and to trap them for processing within your program. You can choose which messages to display and then display the chosen messages in a way that is consistent with the client program's internal message and error handling. This mechanism provides seamless integration of Essbase with your program. Client programs using this API should always use the getMessageHandler() API to retrieve the latest state of the handler.
Parameters:
handler -
Throws:
com.essbase.api.base.EssException

getMessageHandler

IEssCustomMessageHandler getMessageHandler()
                                           throws com.essbase.api.base.EssException
Retrieves the custom message handler associated with the session. Client programs should always use the instance returned by this API to access the latest state of the Custom message handler.
Returns:
IEssCustomMessageHandler or null if one was not associated
Throws:
com.essbase.api.base.EssException
See Also:
setMessageHandler(IEssCustomMessageHandler)

Skip navigation links