IEssCubeOutline (Oracle Essbase Java API Reference)

All Superinterfaces:

IEssBaseObject, IEssExtendedObject, IEssProperties
```
public interface IEssCubeOutline
extends IEssExtendedObject, IEssProperties
```
The IEssCubeOutline is the cube outline.

Version:

1.0, 04/04/2001

Author:

Srini Ranga

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class IEssCubeOutline.EEssAliasTableOption
EEssAliasTableOption class is the alias table option type.
- Nested classes/interfaces inherited from interface com.essbase.api.base.IEssProperties
  IEssProperties.EEssPropertyMode

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IEssCubeOutline.EEssAliasTableOption` EEssAliasTableOption class is the alias table option type.

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`ESS_OTL_NAME_BIUNIQUE`
`static short`	`ESS_OTL_NAME_NONUNIQUE`
`static short`	`ESS_OTL_NAME_UNIQUE`
`static int`	`PROP_ALIAS_TABLE_NAMES`
`static int`	`PROP_AUTO_CONFIGURE`
`static int`	`PROP_CASE_SENSITIVE`
`static int`	`PROP_COUNT_ALIAS_TABLES`
`static int`	`PROP_NAME`
`static int`	`PROP_NON_UNIQUE_NAMES`
`static int`	`PROP_OUTLINE_TYPE`
`static int`	`s_countProperties`
`static IEssValueAny.EEssDataType[]`	`s_propDataTypes`
`static IEssProperties.EEssPropertyMode[]`	`s_propModes`
`static java.lang.String[]`	`s_propNames`
`static int`	`VERIFY_OPTION_AllFORMULA`
`static int`	`VERIFY_OPTION_NONE`
`static int`	`VERIFY_OPTION_SHAREDBEFOREPROTOTYPE`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addQueryHint(IEssMember[] memberArray)` Adds a query hint to the outline.
`void`	`associateAttributeDimension(IEssDimension standardDim, IEssDimension attributeDim)` Associates an attribute dimension with a base dimension.
`void`	`associateAttributeMember(IEssMember standardMbr, IEssMember attributeMbr)` Associates an attribute member with a base member.
`void`	`associateAttributeMember(java.lang.String standardMbrName, java.lang.String attributeMbrName)` Associates an attribute member with a base member.
`void`	`clearAliasTable(java.lang.String aliasTableName)` Clears all entries from an existing alias table without deleting the alias table
`void`	`clearAliasTableLanguage(java.lang.String aliasTableName)` Clears the languages for the alias table
`void`	`close()` Closes the outline freeing all resources associated with the outline.
`void`	`close(boolean ignoreErrors)` Closes the outline freeing all resources associated with the outline.
`void`	`convertToCurrencyOutline()` Converts the current outline to a currency outline.
`void`	`copyAliasTable(java.lang.String srcAliasTableName, java.lang.String destAliasTableName, boolean merge)` Copies an alias table to another alias table.
`void`	`create(boolean caseSensitive, IEssCube.EEssCubeType outlineType, boolean autoConfigure)` Creates a new outline.
`void`	`create(boolean caseSensitive, IEssCube.EEssCubeType outlineType, boolean autoConfigure, boolean allowNonUniqueNames)` Creates a new outline.
`void`	`createAliasTable(java.lang.String aliasTableName)` Creates an empty alias table in the outline.
`void`	`createAliasTable(java.lang.String aliasTableName, IEssCubeOutline.EEssAliasTableOption atOption)` Creates an empty alias table in the outline, with the specified Alias table option.
`IEssDimension`	`createAttributeDimension(java.lang.String dimName, IEssDimension.EEssAttributeDataType attrDataType, IEssDimension prevSibling)` Creates an attribute dimension.
`IEssDimension`	`createDimension(java.lang.String dimName)` Creates a dimension.
`IEssDimension`	`createDimension(java.lang.String dimName, IEssDimension prevSibling)` Creates a dimension.
`IEssPropertyDefinition`	`createPropertyDefinition(IEssDimension dimension, java.lang.String propertyName, int propertyType, IEssValueAny defaultValue, int flags)` Creates the property
`IEssSmartList`	`createSmartList(java.lang.String smartListName)` Creates a smartlist and retruns its instance.
`void`	`deleteAliasTable(java.lang.String aliasTableName)` Deletes the alias table from the outline and clears all of its entries.
`void`	`deleteDTSMemberAlias(java.lang.String dtsMemberName, java.lang.String aliasTableName)` Deletes an alias name for a Dynamic Time Series member.
`void`	`deletePropertyDefinition(IEssPropertyDefinition property)` Delete property
`void`	`deleteQueryHint(int hintNumber)` Deletes a query hint from the outline.
`boolean`	`dimensionHasHybridChildren()` Checks if the outline has any relational descedents.
`void`	`disassociateAttributeDimension(IEssDimension standardDim, IEssDimension attributeDim)` Disassociates an attribute dimension from a base dimension.
`void`	`disassociateAttributeMember(IEssMember standardMbr, IEssMember attributeMbr)` Disassociates an attribute member from a base member
`void`	`enableDTSMember(java.lang.String dtsMemberName, int genNum, boolean enable)` Enables a new Dynamic Time Series members for the outline.
`void`	`enableSystemProperties(IEssDimension dimension, IEssPropertyDefinition.EEssSystemPropertyTags[] systemPropertyTags)`
`IEssIterator`	`executeQuery(java.lang.String mbrName, int queryType, int queryOptions, java.lang.String dimName, java.lang.String input1, java.lang.String input2)` Deprecated. Use `IEssMemberSelection.executeQuery(String, int, int, String, String, String)`.
`IEssIterator`	`executeQuery(java.lang.String fieldSelection, java.lang.String mbrSelection)` Deprecated. Use `IEssMemberSelection.executeQuery(String, String)`.
`IEssMember`	`findAlias(java.lang.String aliasName, java.lang.String aliasTableName)` Finds a member for the alias name.
`IEssIterator`	`findAttributeMembers(java.lang.String attShortName, java.lang.String dimName)` Gets all the attribute members having the specified short name.
`IEssDimension`	`findDimension(java.lang.String mbrName)` Finds a dimension for the member.
`IEssMember`	`findMember(java.lang.String mbrName)` Finds a member.
`IEssMember`	`findMemberOnId(java.lang.String mbrID)` Finds the Member for a given Member ID.
`IEssIterator`	`findMembers(java.lang.String[] mbrNames)` Finds members.
`IEssSmartList`	`findSmartList(java.lang.String smartListName)` Finds a smartlist in the outline and returns its instance.
`IEssCubeOutline`	`generateCurrencyOutline()` Deprecated. Refer `convertToCurrencyOutline()`
`java.lang.String[]`	`getAliasTableLanguages(java.lang.String aliasTableName)` Gets the languages associated with the specified alias table
`java.lang.String[]`	`getAliasTableNames()` Gets the names of alias tables existing in the outline.
`IEssSmartList[]`	`getAllSmartLists()` Returns list of all smartlist for the given outline.
`IEssDimension`	`getASOCompressionDimension()` Gets the compression dimension in an ASO cube outline.
`int`	`getBucketingType()` Gets the numeric attribute's bucketing type.
`int`	`getCountAliasTables()` Gets the count of alias tables existing in the outline.
`int`	`getCountEnabledDTSMembers()` Gets the count of defined DTS members for the outline.
`com.essbase.api.datasource.EssMemberOnTheFly[]`	`getCountMemberOnTheFly(IEssMember[] memberArray)` Retrieves EssMemberOnTheFly[] from the outline for a given dimension / member.
`IEssCube`	`getCube()` Gets the parent cube.
`int`	`getDateFormat()` Gets the format for a datetime attribute.
`java.lang.String`	`getDateFormatString()` Gets Date Format String.
`java.lang.String`	`getDefaultAttrCalcDimName()` Gets the name of the attribute calculations (aggregate) dimension.
`java.lang.String`	`getDefaultAverageMbrName()` Gets the name used with the attribute calculations (aggregate) dimension to indicate AVERAGE.
`java.lang.String`	`getDefaultCountMbrName()` Gets the name used with the attribute calculations (aggregate) dimension to indicate COUNT.
`java.lang.String`	`getDefaultFalseString()` Gets the string used with the boolean attribute to indicate false.
`java.lang.String`	`getDefaultMaxMbrName()` Gets the name used with the attribute calculations (aggregate) dimension to indicate MAXIMUM.
`java.lang.String`	`getDefaultMinMbrName()` Gets the name used with the attribute calculations (aggregate) dimension to indicate MINIMUM.
`java.lang.String`	`getDefaultSumMbrName()` Gets the name used with the attribute calculations (aggregate) dimension to indicate SUM.
`java.lang.String`	`getDefaultTrueString()` Gets the string used with the boolean attribute to indicate true.
`int`	`getDelimiter()` Gets the delimiter to use when generating a long name.
`IEssPropertyDefinition[]`	`getDimensionPropertyDefinitions(IEssDimension dimension, IEssPropertyDefinition.EEssSystemPropertyTags[] systemPropertyTags)`
`IEssPropertyDefinition[]`	`getDimensionPropertyDefinitions(IEssDimension dimension, java.lang.String[] propertyName)` Gets the property definitions for all the property names passed as argument, if null is passed all property definitions defined for the dimension are returned Works only in outline editing mode
`java.lang.String[]`	`getDimensionPropertyNames(IEssDimension dimension)` Gets the property names of all the properties that are defined under the given dimension Works only in outline editing mode
`IEssIterator`	`getDimensions()` Gets the list of dimensions.
`java.lang.String`	`getDTSMemberAlias(java.lang.String dtsMemberName, java.lang.String aliasTableName)` Gets an alias name for a Dynamic Time Series member.
`java.lang.String`	`getEnabledDTSMember(int index)` Gets the defined DTS member name for the outline at the specified index.
`int`	`getGenerationForEnabledDTSMember(int index)` Gets the generation for the defined DTS member name for the outline at the specified index.
`IEssCube.EEssImpliedShare`	`getImpliedShare()` Returns the Implied Share setting of an outline.
`int`	`getOPGVersion()` Returns the Outline OPG version
`short`	`getOutlineNameType()` Gets the outlineName type.
`IEssCube.EEssCubeType`	`getOutlineType()` Gets the outline type.
`int`	`getOutlineVersion()` Returns the Outline version number
`IEssIterator`	`getQueryHint(int hintNumber, int numMembers)` Gets the members associated with a query hint from the outline.
`int`	`getQueryHintsCount()` Gets the number of query hints associated with the outline.
`int`	`getQueryHintsSize()` Gets the count of members in query hints associated with the outline.
`java.lang.String[][]`	`getServerDateFormats(java.lang.String essbaseLocaleString)` Gets the date formats supported by Essbase Server.
`IEssIterator`	`getSharedMembers(java.lang.String mbrName)` Gets all the shared members of the specified member.
`IEssSmartList`	`getSmartListInfo(IEssSmartList smartList)` Returns the smartlist instance containing the smartlist info.
`java.util.Date`	`getUpdateTime()` Gets a timestamp for this outline.
`int`	`getUseNameOf()` Gets which generation(s) of the zero-level member to use when generating a long name.
`boolean`	`isAutoConfigure()` Checks if to automatically configure the dimension storage(dense/sparse) when the outline is saved.
`boolean`	`isCaseSensitive()` Checks if the member names are case-sensitive.
`boolean`	`isGenerationNameByPrefix()` Checks if to use the generation(s) of the zero-level member as the prefix or the suffix when generating a long name.
`boolean`	`isMemberTypeEnabled()` Indicates if the outline supports different Member types such as Smartlist & Date type of members & cells.
`boolean`	`isNonUniqueMemberNameEnabled()` Checks if Non Unique Member Names are allowed in this outline.
`boolean`	`isOpen()` Checks if the outline is open.
`boolean`	`isVaryingAttributeEnabled()` Indicates if the outline is enabled to have Varying Attributes.
`void`	`moveMember(IEssMember mbrToMove, IEssMember newParent, IEssMember newPrevSibling)` Moves a member.
`void`	`open()` Opens the cube outline in read-only mode.
`void`	`open(boolean readOnly, boolean lock, boolean keepTrans)` Opens the cube outline in read-only or read-write mode.
`void`	`open(boolean readOnly, boolean lock, boolean keepTrans, boolean incremental)` Opens the cube outline in read-only or read-write mode.
`void`	`open(boolean readOnly, boolean lock, boolean keepTrans, boolean incremental, boolean dimBldOtl)`
`void`	`refreshPropertyValues()` Refreshes the property values.
`void`	`renameAliasTable(java.lang.String aliasTableName, java.lang.String newAliasTableName)` Renames an existing alias table
`void`	`resetCountMemberOnTheFly()` Resets the member counts previously set for any member in an outline.
`void`	`restructureCube(IEssCube.EEssRestructureOption restructOption)` Restructures the cube based on the newly saved outline.
`void`	`save()` Writes the existing outline information to disk.
`void`	`save(IEssCube.EEssRestructureOption restructOption)` Performs 3 operations in one shot: 1.
`void`	`setAliasTableLanguage(java.lang.String aliasTableName, java.lang.String languageCode)` Sets the language for the alias table.
`void`	`setAltMemberIdAliasTable(java.lang.String altAliasTableName)`
`void`	`setASOCompressionDimension(IEssDimension dim)` Sets the compression dimension in an ASO cube outline.
`void`	`setAutoConfigure(boolean autoConfigure)` Sets if to automatically configure the dimension storage(dense/sparse) when the outline is saved.
`void`	`setBucketingType(int bucketingType)` Sets the numeric attribute's bucketing type.
`void`	`setCaseSensitive(boolean caseSensitive)` Sets if the member names are case-sensitive.
`void`	`setCountMemberOnTheFly(IEssMember[] memberArray, short[] counts)` Set member count in an outline for a given dimension / member.
`void`	`setDateFormat(int dateFormat)` Sets the format for a datetime attribute.
`void`	`setDateFormatString(java.lang.String dateFormatString)` Sets the Date Format String.
`void`	`setDefaultAttrCalcDimName(java.lang.String defAttrCalcDimName)` Sets the name of the attribute calculations (aggregate) dimension.
`void`	`setDefaultAverageMbrName(java.lang.String defAverageMbrName)` Sets the name used with the attribute calculations (aggregate) dimension to indicate AVERAGE.
`void`	`setDefaultCountMbrName(java.lang.String defCountMbrName)` Sets the name used with the attribute calculations (aggregate) dimension to indicate COUNT.
`void`	`setDefaultFalseString(java.lang.String defFalseString)` Sets the string used with the boolean attribute to indicate false.
`void`	`setDefaultMaxMbrName(java.lang.String defMaxMbrName)` Sets the name used with the attribute calculations (aggregate) dimension to indicate MAXIMUM.
`void`	`setDefaultMinMbrName(java.lang.String defMinMbrName)` Sets the name used with the attribute calculations (aggregate) dimension to indicate MINIMUM.
`void`	`setDefaultSumMbrName(java.lang.String defSumMbrName)` Sets the name used with the attribute calculations (aggregate) dimension to indicate SUM.
`void`	`setDefaultTrueString(java.lang.String defTrueString)` Sets the string used with the boolean attribute to indicate true.
`void`	`setDelimiter(int delimiter)` Sets the delimiter to use when generating a long name.
`void`	`setDTSMemberAlias(java.lang.String dtsMemberName, java.lang.String aliasTableName, java.lang.String alias)` Sets an alias name for a Dynamic Time Series member.
`void`	`setGenerationNameByPrefix(boolean genNameByPrefix)` Sets if to use the generation(s) of the zero-level member as the prefix or the suffix when generating a long name.
`void`	`setImpliedShare(IEssCube.EEssImpliedShare impliedShare)` Changes the Implied Share setting of an outline.
`void`	`setMemberTypeEnabled(boolean enableMemberType)` This is to enable an outline for supporting Smartlist, format strings & Date type of members & cells.
`void`	`setNonUniqueMemberNameEnabled(boolean enabled)` Enables/Disables Non Unique Member Names are allowed in this outline.
`void`	`setOutlineNameType(short outlineNameType)` Set the outlineName type.
`void`	`setOutlineType(IEssCube.EEssCubeType otlType)` Sets the outline type.
`void`	`setQueryHint(int hintNumber, IEssMember[] memberArray)` Sets the members associated with a query hint in the outline.
`void`	`setUseNameOf(int whichGen)` Sets which generation(s) of the zero-level member to use when generating a long name.
`void`	`updatePropertyValues()` Updates the property values.
`void`	`verify()` Verifies the outline for correctness.
`void`	`verify(boolean verifyFormula)` Verifies the outline for correctness.
`java.util.ArrayList<com.essbase.api.metadata.EssOutlineError>`	`verifyAllFormula()` Performs formula verification for all the members in the outline.
`java.util.Vector`	`verifyEx(boolean verifyFormula)` Performs Outline Verification.

Methods inherited from interface com.essbase.api.base.IEssExtendedObject
clearClientCache, getName, 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_CASE_SENSITIVE
```
static final int PROP_CASE_SENSITIVE
```
    See Also:
    
    Constant Field Values
  - PROP_OUTLINE_TYPE
```
static final int PROP_OUTLINE_TYPE
```
    See Also:
    
    Constant Field Values
  - PROP_AUTO_CONFIGURE
```
static final int PROP_AUTO_CONFIGURE
```
    See Also:
    
    Constant Field Values
  - PROP_COUNT_ALIAS_TABLES
```
static final int PROP_COUNT_ALIAS_TABLES
```
    See Also:
    
    Constant Field Values
  - PROP_ALIAS_TABLE_NAMES
```
static final int PROP_ALIAS_TABLE_NAMES
```
    See Also:
    
    Constant Field Values
  - PROP_NON_UNIQUE_NAMES
```
static final int PROP_NON_UNIQUE_NAMES
```
    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
```
  - ESS_OTL_NAME_UNIQUE
```
static final short ESS_OTL_NAME_UNIQUE
```
    See Also:
    
    Constant Field Values
  - ESS_OTL_NAME_NONUNIQUE
```
static final short ESS_OTL_NAME_NONUNIQUE
```
    See Also:
    
    Constant Field Values
  - ESS_OTL_NAME_BIUNIQUE
```
static final short ESS_OTL_NAME_BIUNIQUE
```
    See Also:
    
    Constant Field Values
  - VERIFY_OPTION_NONE
```
static final int VERIFY_OPTION_NONE
```
    See Also:
    
    Constant Field Values
  - VERIFY_OPTION_AllFORMULA
```
static final int VERIFY_OPTION_AllFORMULA
```
    See Also:
    
    Constant Field Values
  - VERIFY_OPTION_SHAREDBEFOREPROTOTYPE
```
static final int VERIFY_OPTION_SHAREDBEFOREPROTOTYPE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - isCaseSensitive
```
boolean isCaseSensitive()
                 throws com.essbase.api.base.EssException
```
    Checks if the member names are case-sensitive.
    
    Returns:
    
    true if the member names are case-sensitive.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setCaseSensitive
```
void setCaseSensitive(boolean caseSensitive)
               throws com.essbase.api.base.EssException
```
    Sets if the member names are case-sensitive. The change will become effective after you invoke updatePropertyValues().
    
    Parameters:
    
    caseSensitive - true if the member names are case-sensitive.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getOutlineType
```
IEssCube.EEssCubeType getOutlineType()
                              throws com.essbase.api.base.EssException
```
    Gets the outline type.
    
    Returns:
    
    The outline type.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setOutlineType
```
void setOutlineType(IEssCube.EEssCubeType otlType)
             throws com.essbase.api.base.EssException
```
    Sets the outline type. The change will become effective after you invoke updatePropertyValues().
    
    Parameters:
    
    otlType - The outline type.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getOutlineNameType
```
short getOutlineNameType()
                  throws com.essbase.api.base.EssException
```
    Gets the outlineName type. outlineNameType value can be IEssCubeOutline.ESS_OTL_NAME_*
    
    Returns:
    
    The outlineNameType.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setOutlineNameType
```
void setOutlineNameType(short outlineNameType)
                 throws com.essbase.api.base.EssException
```
    Set the outlineName type.
    
    Parameters:
    
    outlineNameType - The outlineNameType value can be IEssCubeOutline.ESS_OTL_NAME_*
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getOutlineVersion
```
int getOutlineVersion()
               throws com.essbase.api.base.EssException
```
    Returns the Outline version number
    
    Returns:
    
    version number
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getOPGVersion
```
int getOPGVersion()
           throws com.essbase.api.base.EssException
```
    Returns the Outline OPG version
    
    Returns:
    
    OPG version number
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - isAutoConfigure
```
boolean isAutoConfigure()
                 throws com.essbase.api.base.EssException
```
    Checks if to automatically configure the dimension storage(dense/sparse) when the outline is saved.
    
    Returns:
    
    true to auto configure.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setAutoConfigure
```
void setAutoConfigure(boolean autoConfigure)
               throws com.essbase.api.base.EssException
```
    Sets if to automatically configure the dimension storage(dense/sparse) when the outline is saved. The change will become effective after you invoke updatePropertyValues().
    
    Parameters:
    
    autoConfigure - true to auto configure.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - isNonUniqueMemberNameEnabled
```
boolean isNonUniqueMemberNameEnabled()
                              throws com.essbase.api.base.EssException
```
    Checks if Non Unique Member Names are allowed in this outline.
    
    Returns:
    
    true if non-unique member names are allowed.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setNonUniqueMemberNameEnabled
```
void setNonUniqueMemberNameEnabled(boolean enabled)
                            throws com.essbase.api.base.EssException
```
    Enables/Disables Non Unique Member Names are allowed in this outline. The change will become effective after you invoke updatePropertyValues().
    
    Parameters:
    
    enabled - true to enable.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - isMemberTypeEnabled
```
boolean isMemberTypeEnabled()
                     throws com.essbase.api.base.EssException
```
    Indicates if the outline supports different Member types such as Smartlist & Date type of members & cells.
    
    Returns:
    
    true if outline is enabled for textual measures.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setMemberTypeEnabled
```
void setMemberTypeEnabled(boolean enableMemberType)
                   throws com.essbase.api.base.EssException
```
    This is to enable an outline for supporting Smartlist, format strings & Date type of members & cells.
    Note: An outline enabled for supporting Member types cannot be disabled as its a restriction at the Essbase level.
    
    Parameters:
    
    enableMemberType - true to enable Member types .
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getImpliedShare
```
IEssCube.EEssImpliedShare getImpliedShare()
                                   throws com.essbase.api.base.EssException
```
    Returns the Implied Share setting of an outline.
    
    Returns:
    
    The implied share
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setImpliedShare
```
void setImpliedShare(IEssCube.EEssImpliedShare impliedShare)
              throws com.essbase.api.base.EssException
```
    Changes the Implied Share setting of an outline. No changes take effect until the outline is saved and restructured. The explicit settings are especially useful if the application later is copied, as the setting would be �sticky� and follow the outline independent of any application name specific entry in the Essbase.cfg file.
    
    Parameters:
    
    impliedShare - The implied share
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - isVaryingAttributeEnabled
```
boolean isVaryingAttributeEnabled()
                           throws com.essbase.api.base.EssException
```
    Indicates if the outline is enabled to have Varying Attributes.
    
    Returns:
    
    true if outline is enabled for varying attributes.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getCountAliasTables
```
int getCountAliasTables()
                 throws com.essbase.api.base.EssException
```
    Gets the count of alias tables existing in the outline.
    
    Returns:
    
    The count of alias tables.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getAliasTableNames
```
java.lang.String[] getAliasTableNames()
                               throws com.essbase.api.base.EssException
```
    Gets the names of alias tables existing in the outline.
    
    Returns:
    
    The alias table names.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - isGenerationNameByPrefix
```
boolean isGenerationNameByPrefix()
                          throws com.essbase.api.base.EssException
```
    Checks if to use the generation(s) of the zero-level member as the prefix or the suffix when generating a long name. This is an attribute specification for the outline. The default value is true.
    
    Returns:
    
    true to use generation name by prefix.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setGenerationNameByPrefix
```
void setGenerationNameByPrefix(boolean genNameByPrefix)
                        throws com.essbase.api.base.EssException
```
    Sets if to use the generation(s) of the zero-level member as the prefix or the suffix when generating a long name. This is an attribute specification for the outline. The change will become effective after you invoke updatePropertyValues().
    
    Parameters:
    
    genNameByPrefix - true to use generation name by prefix.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getUseNameOf
```
int getUseNameOf()
          throws com.essbase.api.base.EssException
```
    Gets which generation(s) of the zero-level member to use when generating a long name. This is an attribute specification for the outline.
    
    Returns:
    
    0 for none (default), 1 for parent, 2 for grand parent and parent, 3 for all ancestors, 4 for dimension.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setUseNameOf
```
void setUseNameOf(int whichGen)
           throws com.essbase.api.base.EssException
```
    Sets which generation(s) of the zero-level member to use when generating a long name. This is an attribute specification for the outline. The change will become effective after you invoke updatePropertyValues().
    
    Parameters:
    
    whichGen - 0 for none (default), 1 for parent, 2 for grand parent and parent, 3 for all ancestors, 4 for dimension.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getDelimiter
```
int getDelimiter()
          throws com.essbase.api.base.EssException
```
    Gets the delimiter to use when generating a long name. This is an attribute specification for the outline.
    
    Returns:
    
    0 for underscore (default), 1 for pipe, 2 for caret.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setDelimiter
```
void setDelimiter(int delimiter)
           throws com.essbase.api.base.EssException
```
    Sets the delimiter to use when generating a long name. This is an attribute specification for the outline. The change will become effective after you invoke updatePropertyValues().
    
    Parameters:
    
    delimiter - 0 for underscore (default), 1 for pipe, 2 for caret.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getDateFormat
```
int getDateFormat()
           throws com.essbase.api.base.EssException
```
    Gets the format for a datetime attribute. This is an attribute specification for the outline.
    
    Returns:
    
    0 for MMDDYYYY (default), 1 for DDMMYY.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setDateFormat
```
void setDateFormat(int dateFormat)
            throws com.essbase.api.base.EssException
```
    Sets the format for a datetime attribute. This is an attribute specification for the outline. The change will become effective after you invoke updatePropertyValues().
    
    Parameters:
    
    dateFormat - 0 for MMDDYYYY (default), 1 for DDMMYY.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getBucketingType
```
int getBucketingType()
              throws com.essbase.api.base.EssException
```
    Gets the numeric attribute's bucketing type. This is an attribute specification for the outline.
    
    Returns:
    
    0 for upper bound inclusive (default), 1 for lower bound inclusive, 2 for upper bound non inclusive, 3 for lower bound non inclusive.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setBucketingType
```
void setBucketingType(int bucketingType)
               throws com.essbase.api.base.EssException
```
    Sets the numeric attribute's bucketing type. This is an attribute specification for the outline. The change will become effective after you invoke updatePropertyValues().
    
    Parameters:
    
    bucketingType - 0 for upper bound inclusive (default), 1 for lower bound inclusive, 2 for upper bound non inclusive, 3 for lower bound non inclusive.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getDefaultTrueString
```
java.lang.String getDefaultTrueString()
                               throws com.essbase.api.base.EssException
```
    Gets the string used with the boolean attribute to indicate true. This is an attribute specification for the outline.
    
    Returns:
    
    The string used to indicate true. Default value is "True".
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setDefaultTrueString
```
void setDefaultTrueString(java.lang.String defTrueString)
                   throws com.essbase.api.base.EssException
```
    Sets the string used with the boolean attribute to indicate true. This is an attribute specification for the outline. The change will become effective after you invoke updatePropertyValues().
    
    Parameters:
    
    defTrueString - The default true string.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getDefaultFalseString
```
java.lang.String getDefaultFalseString()
                                throws com.essbase.api.base.EssException
```
    Gets the string used with the boolean attribute to indicate false. This is an attribute specification for the outline.
    
    Returns:
    
    The string used to indicate false. Default value is "False".
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setDefaultFalseString
```
void setDefaultFalseString(java.lang.String defFalseString)
                    throws com.essbase.api.base.EssException
```
    Sets the string used with the boolean attribute to indicate false. This is an attribute specification for the outline. The change will become effective after you invoke updatePropertyValues().
    
    Parameters:
    
    defFalseString - The default false string.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getDefaultAttrCalcDimName
```
java.lang.String getDefaultAttrCalcDimName()
                                    throws com.essbase.api.base.EssException
```
    Gets the name of the attribute calculations (aggregate) dimension. The default value is "Attribute Calculations". This is an attribute specification for the outline.
    
    Returns:
    
    The default attribute calculation dimension name.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setDefaultAttrCalcDimName
```
void setDefaultAttrCalcDimName(java.lang.String defAttrCalcDimName)
                        throws com.essbase.api.base.EssException
```
    Sets the name of the attribute calculations (aggregate) dimension. The default value is "Attribute Calculations". This is an attribute specification for the outline. The change will become effective after you invoke updatePropertyValues().
    
    Parameters:
    
    defAttrCalcDimName - The default attribute calculation dimension name.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getDefaultSumMbrName
```
java.lang.String getDefaultSumMbrName()
                               throws com.essbase.api.base.EssException
```
    Gets the name used with the attribute calculations (aggregate) dimension to indicate SUM. The default value is "Sum". This is an attribute specification for the outline.
    
    Returns:
    
    The name to indicate SUM.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setDefaultSumMbrName
```
void setDefaultSumMbrName(java.lang.String defSumMbrName)
                   throws com.essbase.api.base.EssException
```
    Sets the name used with the attribute calculations (aggregate) dimension to indicate SUM. The default value is "Sum". This is an attribute specification for the outline. The change will become effective after you invoke updatePropertyValues().
    
    Parameters:
    
    defSumMbrName - The name to indicate SUM.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getDefaultCountMbrName
```
java.lang.String getDefaultCountMbrName()
                                 throws com.essbase.api.base.EssException
```
    Gets the name used with the attribute calculations (aggregate) dimension to indicate COUNT. The default value is "Count". This is an attribute specification for the outline.
    
    Returns:
    
    The name to indicate COUNT.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setDefaultCountMbrName
```
void setDefaultCountMbrName(java.lang.String defCountMbrName)
                     throws com.essbase.api.base.EssException
```
    Sets the name used with the attribute calculations (aggregate) dimension to indicate COUNT. The default value is "Count". This is an attribute specification for the outline. The change will become effective after you invoke updatePropertyValues().
    
    Parameters:
    
    defCountMbrName - The name to indicate COUNT.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getDefaultAverageMbrName
```
java.lang.String getDefaultAverageMbrName()
                                   throws com.essbase.api.base.EssException
```
    Gets the name used with the attribute calculations (aggregate) dimension to indicate AVERAGE. The default value is "Average". This is an attribute specification for the outline.
    
    Returns:
    
    The name to indicate AVERAGE.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setDefaultAverageMbrName
```
void setDefaultAverageMbrName(java.lang.String defAverageMbrName)
                       throws com.essbase.api.base.EssException
```
    Sets the name used with the attribute calculations (aggregate) dimension to indicate AVERAGE. The default value is "Average". This is an attribute specification for the outline. The change will become effective after you invoke updatePropertyValues().
    
    Parameters:
    
    defAverageMbrName - The name to indicate AVERAGE.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getDefaultMinMbrName
```
java.lang.String getDefaultMinMbrName()
                               throws com.essbase.api.base.EssException
```
    Gets the name used with the attribute calculations (aggregate) dimension to indicate MINIMUM. The default value is "Min". This is an attribute specification for the outline.
    
    Returns:
    
    The name to indicate MINIMUM.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setDefaultMinMbrName
```
void setDefaultMinMbrName(java.lang.String defMinMbrName)
                   throws com.essbase.api.base.EssException
```
    Sets the name used with the attribute calculations (aggregate) dimension to indicate MINIMUM. The default value is "Min". This is an attribute specification for the outline. The change will become effective after you invoke updatePropertyValues().
    
    Parameters:
    
    defMinMbrName - The name to indicate MINIMUM.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getDefaultMaxMbrName
```
java.lang.String getDefaultMaxMbrName()
                               throws com.essbase.api.base.EssException
```
    Gets the name used with the attribute calculations (aggregate) dimension to indicate MAXIMUM. The default value is "Max". This is an attribute specification for the outline.
    
    Returns:
    
    The name to indicate MAXIMUM.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setDefaultMaxMbrName
```
void setDefaultMaxMbrName(java.lang.String defMaxMbrName)
                   throws com.essbase.api.base.EssException
```
    Sets the name used with the attribute calculations (aggregate) dimension to indicate MAXIMUM. The default value is "Max". This is an attribute specification for the outline. The change will become effective after you invoke updatePropertyValues().
    
    Parameters:
    
    defMaxMbrName - The name to indicate MAXIMUM.
    
    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.
  - 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().
    
    Specified by:
    
    updatePropertyValues in interface IEssProperties
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - open
```
void open()
   throws com.essbase.api.base.EssException
```
    Opens the cube outline in read-only mode.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - open
```
void open(boolean readOnly,
          boolean lock,
          boolean keepTrans)
   throws com.essbase.api.base.EssException
```
    Opens the cube outline in read-only or read-write mode.
    
    Parameters:
    
    readOnly - true to open the outline in read-only mode. false to open the outline in read-write mode.
    
    lock - true if the outline should be locked when it is opened in any mode.
    
    keepTrans - true to keep transactions. If you are opening an existing outline to make changes (readOnly == false), and you intend to restructure the cube and keep data, we recommend that you set this flag to true. When true, a log is kept of activities done to the outline. If you are starting from an empty outline or are not planning on saving data when you restructure, we recommend that you set this field to false. When false, no log is kept, saving time and memory.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - open
```
void open(boolean readOnly,
          boolean lock,
          boolean keepTrans,
          boolean incremental)
   throws com.essbase.api.base.EssException
```
    Opens the cube outline in read-only or read-write mode.
    
    Parameters:
    
    readOnly - true to open the outline in read-only mode. false to open the outline in read-write mode.
    
    lock - true if the outline should be locked when it is opened in any mode.
    
    keepTrans - true to keep transactions. If you are opening an existing outline to make changes (readOnly == false), and you intend to restructure the cube and keep data, we recommend that you set this flag to true. When true, a log is kept of activities done to the outline. If you are starting from an empty outline or are not planning on saving data when you restructure, we recommend that you set this field to false. When false, no log is kept, saving time and memory.
    
    incremental - if outline should be opened in incremental mode.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - open
```
void open(boolean readOnly,
          boolean lock,
          boolean keepTrans,
          boolean incremental,
          boolean dimBldOtl)
   throws com.essbase.api.base.EssException
```
    Throws:
    
    com.essbase.api.base.EssException
  - isOpen
```
boolean isOpen()
        throws com.essbase.api.base.EssException
```
    Checks if the outline is open.
    
    Returns:
    
    true if the outline is open.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getCountMemberOnTheFly
```
com.essbase.api.datasource.EssMemberOnTheFly[] getCountMemberOnTheFly(IEssMember[] memberArray)
                                                               throws com.essbase.api.base.EssException
```
    Retrieves EssMemberOnTheFly[] from the outline for a given dimension / member. This works in outline editing mode. Each member in IEssMember[] argument to the API should be any level-1 and above members. If member name is a Dimension then all the output list of EssMemberOnTheFly[] will contain a list of all the level 1 (parents) members and the corresponding counts. It will also contain all the level-1 and above alternate hierarchy members and counts.
    
    Parameters:
    
    memberArray - The IEssMember array for member on the fly count
    
    Returns:
    
    EssMemberOnTheFly[] - EssMemberOnTheFly instances. inputMbr - The input member name it corresponds to parentMbr - The level1 or parent member name maxCount - Configured max count freeCount - Free count
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setCountMemberOnTheFly
```
void setCountMemberOnTheFly(IEssMember[] memberArray,
                            short[] counts)
                     throws com.essbase.api.base.EssException
```
    Set member count in an outline for a given dimension / member. Each member in iessMembers must be either a level-1 member, or a dimension If the member is level 1 sets maximum number of children that can be added to without a restructure. If the member is a dimension sets the maximum number of children that can be added to each level 1 in all stored hierarchies.
    
    Parameters:
    
    memberArray - The IEssMember[] with the members
    
    counts - short[] with number of members to add under each given dimension / member
    
    Throws:
    
    com.essbase.api.base.EssException - is an error occurs.
  - resetCountMemberOnTheFly
```
void resetCountMemberOnTheFly()
                       throws com.essbase.api.base.EssException
```
    Resets the member counts previously set for any member in an outline.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - create
```
void create(boolean caseSensitive,
            IEssCube.EEssCubeType outlineType,
            boolean autoConfigure)
     throws com.essbase.api.base.EssException
```
    Creates a new outline.
    
    Parameters:
    
    caseSensitive - true for case-sensitive member names.
    
    outlineType - The Outline type.
    
    autoConfigure - true to automatically configure the dimension. storage (dense/sparse) when the outline is saved.
    
    Throws:
    
    com.essbase.api.base.EssException - is an error occurs.
  - create
```
void create(boolean caseSensitive,
            IEssCube.EEssCubeType outlineType,
            boolean autoConfigure,
            boolean allowNonUniqueNames)
     throws com.essbase.api.base.EssException
```
    Creates a new outline.
    
    Parameters:
    
    caseSensitive - true for case-sensitive member names.
    
    outlineType - The Outline type.
    
    autoConfigure - true to automatically configure the dimension. storage (dense/sparse) when the outline is saved.
    
    allowNonUniqueNames - if true, the outline created will allow non unique member names.
    
    Throws:
    
    com.essbase.api.base.EssException - is an error occurs.
  - close
```
void close()
    throws com.essbase.api.base.EssException
```
    Closes the outline freeing all resources associated with the outline. This method internally invokes close(false). Once this call is made, make sure not to use the member or dimension objects obtained prior to closing.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - close
```
void close(boolean ignoreErrors)
    throws com.essbase.api.base.EssException
```
    Closes the outline freeing all resources associated with the outline. Once this call is made, make sure not to use the member or dimension objects obtained prior to closing.
    
    Parameters:
    
    ignoreErrors - true to ignore errors if any and close the outline, false to throw exception in case of errors and not close the outline.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - save
```
void save()
   throws com.essbase.api.base.EssException
```
    Writes the existing outline information to disk.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - save
```
void save(IEssCube.EEssRestructureOption restructOption)
   throws com.essbase.api.base.EssException
```
    Performs 3 operations in one shot: 1. Verifies the outline, 2. Writes the outline information to disk if verification (step-1) is successful, 3. Restructures the cube if writing (step-2) is successful.
    
    Parameters:
    
    restructOption - The restructure option.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getUpdateTime
```
java.util.Date getUpdateTime()
                      throws com.essbase.api.base.EssException
```
    Gets a timestamp for this outline. The returned value for time is not persistent; that is, the value for time is reset whenever the server loads the cube.
    
    Returns:
    
    The timestamp.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - verify
```
void verify()
     throws com.essbase.api.base.EssException
```
    Verifies the outline for correctness.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - verify
```
void verify(boolean verifyFormula)
     throws com.essbase.api.base.EssException
```
    Verifies the outline for correctness.
    
    Parameters:
    
    verifyFormula - true if formulas should be verified while verifying outline.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - verifyEx
```
java.util.Vector verifyEx(boolean verifyFormula)
                   throws com.essbase.api.base.EssException
```
    Performs Outline Verification. This behaves like verify(boolean) but does not throw an exception of outline errors, instead returns the errors,warnings as a Vector.
    
    Parameters:
    
    verifyFormula - true if formulas should be verified while verifying outline.
    
    Returns:
    
    Vector : Warning/Error, if outline verification returns warning/error
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - verifyAllFormula
```
java.util.ArrayList<com.essbase.api.metadata.EssOutlineError> verifyAllFormula()
                                                                        throws com.essbase.api.base.EssException
```
    Performs formula verification for all the members in the outline. This returns the list of all the formula errors/warnings. Each error/warning in the list has the member unique name, the essbase error code and message.
    
    Returns:
    
    ArrayList : An arrayList of EssOutlineError Object containing formula failure errors/warnings if any.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - createDimension
```
IEssDimension createDimension(java.lang.String dimName)
                       throws com.essbase.api.base.EssException
```
    Creates a dimension. If you add a dimension that is virtual (dynamic calc or label only), then any data existing in the cube is stored with the first level-0 stored member in the new dimension. There must be at least one stored member in the hierarchy.
    
    Parameters:
    
    dimName - The dimension name.
    
    Returns:
    
    The dimension.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - createDimension
```
IEssDimension createDimension(java.lang.String dimName,
                              IEssDimension prevSibling)
                       throws com.essbase.api.base.EssException
```
    Creates a dimension. If you add a dimension that is virtual (dynamic calc or label only), then any data existing in the cube is stored with the first level-0 stored member in the new dimension. There must be at least one stored member in the hierarchy.
    
    Parameters:
    
    dimName - The dimension name.
    
    prevSibling - The previous sibling dimension. The new dimension will be placed after this dimension.
    
    Returns:
    
    The dimension.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - createAttributeDimension
```
IEssDimension createAttributeDimension(java.lang.String dimName,
                                       IEssDimension.EEssAttributeDataType attrDataType,
                                       IEssDimension prevSibling)
                                throws com.essbase.api.base.EssException
```
    Creates an attribute dimension. If you add a dimension that is virtual (dynamic calc or label only), then any data existing in the cube is stored with the first level-0 stored member in the new dimension. There must be at least one stored member in the hierarchy.
    
    Parameters:
    
    dimName - The attribute dimension name.
    
    attrDataType - The attribute dimension data type.
    
    prevSibling - The previous sibling dimension. The new dimension will be placed after this dimension.
    
    Returns:
    
    The dimension.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - createPropertyDefinition
```
IEssPropertyDefinition createPropertyDefinition(IEssDimension dimension,
                                                java.lang.String propertyName,
                                                int propertyType,
                                                IEssValueAny defaultValue,
                                                int flags)
                                         throws com.essbase.api.base.EssException
```
    Creates the property
    
    Parameters:
    
    dimension - The dimension for a property.
    
    propertyName - The property name.
    
    propertyType - The property data type should be one of IEssPropertyDefinition.ESS_MBRPROP_DT_NUMBER, IEssPropertyDefinition.ESS_MBRPROP_DT_BOOL, IEssPropertyDefinition.ESS_MBRPROP_DT_DATETIME, IEssPropertyDefinition.ESS_MBRPROP_DT_TEXT or IEssPropertyDefinition.ESS_MBRPROP_DT_NONE
    
    defaultValue - The property default value.
    
    flags - can be IEssPropertyDefinition.ESS_MBRPROPFLAG_PROPERTY_INDEXED, IEssPropertyDefinition.ESS_MBRPROPFLAG_PROPERTY_SHARE, IEssPropertyDefinition.ESS_MBRPROPFLAG_PROPERTY_UNIQUE or the combination these constants
    
    Returns:
    
    The PropertyDefinition
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - deletePropertyDefinition
```
void deletePropertyDefinition(IEssPropertyDefinition property)
                       throws com.essbase.api.base.EssException
```
    Delete property
    
    Parameters:
    
    property - The PropertyDefinition
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getDimensionPropertyDefinitions
```
IEssPropertyDefinition[] getDimensionPropertyDefinitions(IEssDimension dimension,
                                                         java.lang.String[] propertyName)
                                                  throws com.essbase.api.base.EssException
```
    Gets the property definitions for all the property names passed as argument, if null is passed all property definitions defined for the dimension are returned Works only in outline editing mode
    
    Parameters:
    
    dimension - The dimension
    
    propertyName - The property names.
    
    Returns:
    
    propertyDefinitions
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getDimensionPropertyDefinitions
```
IEssPropertyDefinition[] getDimensionPropertyDefinitions(IEssDimension dimension,
                                                         IEssPropertyDefinition.EEssSystemPropertyTags[] systemPropertyTags)
                                                  throws com.essbase.api.base.EssException
```
    Throws:
    
    com.essbase.api.base.EssException
  - getDimensionPropertyNames
```
java.lang.String[] getDimensionPropertyNames(IEssDimension dimension)
                                      throws com.essbase.api.base.EssException
```
    Gets the property names of all the properties that are defined under the given dimension Works only in outline editing mode
    
    Parameters:
    
    dimension - The dimension
    
    Returns:
    
    propertyNames
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - enableSystemProperties
```
void enableSystemProperties(IEssDimension dimension,
                            IEssPropertyDefinition.EEssSystemPropertyTags[] systemPropertyTags)
                     throws com.essbase.api.base.EssException
```
    Throws:
    
    com.essbase.api.base.EssException
  - getDimensions
```
IEssIterator getDimensions()
                    throws com.essbase.api.base.EssException
```
    Gets the list of dimensions.
    
    Returns:
    
    The list of dimensions (each of type IEssDimension).
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - moveMember
```
void moveMember(IEssMember mbrToMove,
                IEssMember newParent,
                IEssMember newPrevSibling)
         throws com.essbase.api.base.EssException
```
    Moves a member.
    
    Parameters:
    
    mbrToMove - The member to move
    
    newParent - The new parent. Use this field only if the newPrevSibling field is null.
    
    newPrevSibling - The new previous sibling.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - findMember
```
IEssMember findMember(java.lang.String mbrName)
               throws com.essbase.api.base.EssException
```
    Finds a member. This method is a wrapper on top of findMembers(), and to fetch multiple members in one round trip use findMembers() instead of this method.
    
    Parameters:
    
    mbrName - The member name to find.
    
    Returns:
    
    The member.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs. If the member is not found, the error code is set to ERROR_OBJECT_NOT_FOUND.
  - findMembers
```
IEssIterator findMembers(java.lang.String[] mbrNames)
                  throws com.essbase.api.base.EssException
```
    Finds members. If some of the specified members are not found, there will not be any exception, and the iterator returned will not contain those members.
    
    Parameters:
    
    mbrNames - The member names to find.
    
    Returns:
    
    The members that are found (each of type IEssMember).
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs. If the member is not found, the error code is set to ERROR_OBJECT_NOT_FOUND.
  - findMemberOnId
```
IEssMember findMemberOnId(java.lang.String mbrID)
                   throws com.essbase.api.base.EssException
```
    Finds the Member for a given Member ID. If no member found for this specified ID, it returns null.
    
    Parameters:
    
    mbrID - member ID
    
    Returns:
    
    Member object if there exists a member associated with the given ID, otherwise, returns null.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - findDimension
```
IEssDimension findDimension(java.lang.String mbrName)
                     throws com.essbase.api.base.EssException
```
    Finds a dimension for the member.
    
    Parameters:
    
    mbrName - The member name.
    
    Returns:
    
    The dimension.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs. If the dimension is not found, the error code is set to ERROR_OBJECT_NOT_FOUND.
  - restructureCube
```
void restructureCube(IEssCube.EEssRestructureOption restructOption)
              throws com.essbase.api.base.EssException
```
    Restructures the cube based on the newly saved outline.
    
    Parameters:
    
    restructOption - The restructure option.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - createAliasTable
```
void createAliasTable(java.lang.String aliasTableName)
               throws com.essbase.api.base.EssException
```
    Creates an empty alias table in the outline.
    
    Parameters:
    
    aliasTableName - The name of alias table to create.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - createAliasTable
```
void createAliasTable(java.lang.String aliasTableName,
                      IEssCubeOutline.EEssAliasTableOption atOption)
               throws com.essbase.api.base.EssException
```
    Creates an empty alias table in the outline, with the specified Alias table option.
    
    Parameters:
    
    aliasTableName - The name of alias table to create.
    
    atOption - Option type while creating the alias table.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setAltMemberIdAliasTable
```
void setAltMemberIdAliasTable(java.lang.String altAliasTableName)
                       throws com.essbase.api.base.EssException
```
    Throws:
    
    com.essbase.api.base.EssException
  - copyAliasTable
```
void copyAliasTable(java.lang.String srcAliasTableName,
                    java.lang.String destAliasTableName,
                    boolean merge)
             throws com.essbase.api.base.EssException
```
    Copies an alias table to another alias table.
    
    Parameters:
    
    srcAliasTableName - The name of alias table to copy from. If this parameter is null, the default alias table is used.
    
    destAliasTableName - The name of alias table to copy to. Cannot be the same as srcAliasTableName.
    
    merge - true to merge the source file into the existing destination alias table. false to clear the destination alias table before copying.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - renameAliasTable
```
void renameAliasTable(java.lang.String aliasTableName,
                      java.lang.String newAliasTableName)
               throws com.essbase.api.base.EssException
```
    Renames an existing alias table
    
    Parameters:
    
    aliasTableName - The name of alias table to rename.
    
    newAliasTableName - The new name for alias table.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - clearAliasTable
```
void clearAliasTable(java.lang.String aliasTableName)
              throws com.essbase.api.base.EssException
```
    Clears all entries from an existing alias table without deleting the alias table
    
    Parameters:
    
    aliasTableName - The name of alias table to clear. Use null or "Default" for the default table.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - deleteAliasTable
```
void deleteAliasTable(java.lang.String aliasTableName)
               throws com.essbase.api.base.EssException
```
    Deletes the alias table from the outline and clears all of its entries.
    
    Parameters:
    
    aliasTableName - The name of alias table to delete.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - findAlias
```
IEssMember findAlias(java.lang.String aliasName,
                     java.lang.String aliasTableName)
              throws com.essbase.api.base.EssException
```
    Finds a member for the alias name.
    
    Parameters:
    
    aliasName - The alias name to find member for.
    
    aliasTableName - The alias table name which provides the alias.
    
    Returns:
    
    The member.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs. If the member is not found, the error code is set to ERROR_OBJECT_NOT_FOUND.
  - getDTSMemberAlias
```
java.lang.String getDTSMemberAlias(java.lang.String dtsMemberName,
                                   java.lang.String aliasTableName)
                            throws com.essbase.api.base.EssException
```
    Gets an alias name for a Dynamic Time Series member.
    
    Parameters:
    
    dtsMemberName - The DTS member name which provides the alias.
    
    aliasTableName - The alias table name which provides the alias. If null, the default alias table is used
    
    Returns:
    
    The alias name for the DTS member.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setDTSMemberAlias
```
void setDTSMemberAlias(java.lang.String dtsMemberName,
                       java.lang.String aliasTableName,
                       java.lang.String alias)
                throws com.essbase.api.base.EssException
```
    Sets an alias name for a Dynamic Time Series member.
    
    Parameters:
    
    dtsMemberName - The DTS member name which provides the alias.
    
    aliasTableName - The alias table name which provides the alias. If null, the default alias table is used
    
    alias - The alias name for the DTS member.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - deleteDTSMemberAlias
```
void deleteDTSMemberAlias(java.lang.String dtsMemberName,
                          java.lang.String aliasTableName)
                   throws com.essbase.api.base.EssException
```
    Deletes an alias name for a Dynamic Time Series member.
    
    Parameters:
    
    dtsMemberName - The name of the DTS member which provides the alias.
    
    aliasTableName - The name of the alias table which provides the alias. If null, use the default alias table.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - enableDTSMember
```
void enableDTSMember(java.lang.String dtsMemberName,
                     int genNum,
                     boolean enable)
              throws com.essbase.api.base.EssException
```
    Enables a new Dynamic Time Series members for the outline.
    
    Parameters:
    
    dtsMemberName - The name of the DTS member.
    
    genNum - The generation to assign to the DTS member.
    
    enable - true to enable the DTS member.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getCountEnabledDTSMembers
```
int getCountEnabledDTSMembers()
                       throws com.essbase.api.base.EssException
```
    Gets the count of defined DTS members for the outline.
    
    Returns:
    
    The count of defined DTS members.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getEnabledDTSMember
```
java.lang.String getEnabledDTSMember(int index)
                              throws com.essbase.api.base.EssException
```
    Gets the defined DTS member name for the outline at the specified index.
    
    Parameters:
    
    index - The index where to get the DTS member from. This should be between 0 and the value returned by getCountEnabledDTSMembers().
    
    Returns:
    
    The DTS member name.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getGenerationForEnabledDTSMember
```
int getGenerationForEnabledDTSMember(int index)
                              throws com.essbase.api.base.EssException
```
    Gets the generation for the defined DTS member name for the outline at the specified index.
    
    Parameters:
    
    index - The index where to get the DTS member from. This should be between 0 and the value returned by getCountEnabledDTSMembers().
    
    Returns:
    
    The generation number.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - generateCurrencyOutline
```
IEssCubeOutline generateCurrencyOutline()
                                 throws com.essbase.api.base.EssException
```
    Deprecated. Refer convertToCurrencyOutline()
    
    Generates a currency outline based on the current (source) outline. The source outline must have a Time, Accounts, and Country dimension. Time dimension and all descendants are copied directly from the source outline to a Time dimension in the new outline. A dimension named CurCategory (Dense, Category = Accounts) is created in the new outline. All currency categories in the source Accounts dimension become children of the CurCategory dimension in the new outline. A dimension named CurName (Dense, Category = Country) is created in the new outline. All currency names from the source Country dimension become children of the CurName dimension in the new outline. A dimension named CurType (Sparse, Category = Type) is created with no children in the new outline. The currency outline must be saved by calling save() followed by restructure() and closed by calling close(). The new outline has the following attributes: Auto-configure is set to ESS_TRUE, Case-sensitivity is the same as the original outline.
    
    Returns:
    
    The currency outline.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - convertToCurrencyOutline
```
void convertToCurrencyOutline()
                       throws com.essbase.api.base.EssException
```
    Converts the current outline to a currency outline. The source outline must have a Time, Accounts, and Country dimension. Except the Time dimension all the other dimensions will be deleted in the converted outline. A dimension named CurCategory (Dense, Category = Accounts) is created in the converted outline. All currency categories in the source Accounts dimension become children of the CurCategory dimension in the converted outline. A dimension named CurName (Dense, Category = Country) is created in the converted outline. All currency names from the source Country dimension become children of the CurName dimension in the converted outline. A dimension named CurType (Sparse, Category = Type) is created with no children in the converted outline. The currency outline must be saved by calling save() followed by restructure() and closed by calling close(). The converted outline has the following attributes: Auto-configure is set to ESS_TRUE, Case-sensitivity is the same as the original outline.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - associateAttributeDimension
```
void associateAttributeDimension(IEssDimension standardDim,
                                 IEssDimension attributeDim)
                          throws com.essbase.api.base.EssException
```
    Associates an attribute dimension with a base dimension.
    
    Parameters:
    
    standardDim - The standard or base dimension.
    
    attributeDim - The attribute dimension.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - disassociateAttributeDimension
```
void disassociateAttributeDimension(IEssDimension standardDim,
                                    IEssDimension attributeDim)
                             throws com.essbase.api.base.EssException
```
    Disassociates an attribute dimension from a base dimension.
    
    Parameters:
    
    standardDim - The standard or base dimension.
    
    attributeDim - The attribute dimension.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - associateAttributeMember
```
void associateAttributeMember(IEssMember standardMbr,
                              IEssMember attributeMbr)
                       throws com.essbase.api.base.EssException
```
    Associates an attribute member with a base member.
    
    Parameters:
    
    standardMbr - The standard or base member.
    
    attributeMbr - The attribute member.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - associateAttributeMember
```
void associateAttributeMember(java.lang.String standardMbrName,
                              java.lang.String attributeMbrName)
                       throws com.essbase.api.base.EssException
```
    Associates an attribute member with a base member.
    
    Parameters:
    
    standardMbrName - The standard or base member name.
    
    attributeMbrName - The attribute member name.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - disassociateAttributeMember
```
void disassociateAttributeMember(IEssMember standardMbr,
                                 IEssMember attributeMbr)
                          throws com.essbase.api.base.EssException
```
    Disassociates an attribute member from a base member
    
    Parameters:
    
    standardMbr - The standard or base member.
    
    attributeMbr - The attribute member.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - findAttributeMembers
```
IEssIterator findAttributeMembers(java.lang.String attShortName,
                                  java.lang.String dimName)
                           throws com.essbase.api.base.EssException
```
    Gets all the attribute members having the specified short name.
    
    Parameters:
    
    attShortName - The attribute short name (A zero-level attribute member that is not of type ESS_ATTRMBRDT_STRING is called a short name).
    
    dimName - The attribute dimension name. "" can also be passed.
    
    Returns:
    
    The list of base members (each of type IEssMember).
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getSharedMembers
```
IEssIterator getSharedMembers(java.lang.String mbrName)
                       throws com.essbase.api.base.EssException
```
    Gets all the shared members of the specified member.
    
    Parameters:
    
    mbrName - The member name.
    
    Returns:
    
    The shared members.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - executeQuery
```
IEssIterator executeQuery(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
```
    Deprecated. Use IEssMemberSelection.executeQuery(String, int, int, String, String, String).
    
    Member selection over outline. Refer to IEssMemberSelection.executeQuery for more description.
    
    Parameters:
    
    mbrName - The name of the member to do the operation on. If this value is null, it is assumed to be the very top of the outline, representing the logical parent of the dimensions. This value will be ignored for the following query types (specified by queryType param): QUERY_TYPE_NAMEDGENERATION, QUERY_TYPE_NAMEDLEVEL, QUERY_TYPE_USERATTRIBUTE, QUERY_TYPE_SEARCH, QUERY_TYPE_WILDSEARCH.
    
    queryType - Type of the query. Value defining the operation to perform. It can be one of the following: QUERY_TYPE_CHILDREN, QUERY_TYPE_DESCENDANTS, QUERY_TYPE_BOTTOMLEVEL, QUERY_TYPE_SIBLINGS, QUERY_TYPE_SAMELEVEL, QUERY_TYPE_SAMEGENERATION, QUERY_TYPE_PARENT, QUERY_TYPE_DIMENSION, QUERY_TYPE_NAMEDGENERATION, QUERY_TYPE_NAMEDLEVEL, QUERY_TYPE_SEARCH, QUERY_TYPE_WILDSEARCH, QUERY_TYPE_USERATTRIBUTE, QUERY_TYPE_ANCESTORS, QUERY_TYPE_DTSMEMBERS, QUERY_TYPE_INDEPDIMS, QUERY_TYPE_INDEPDIMS_DISCRETE, QUERY_TYPE_INDEPDIMS_CONTINUOUS, QUERY_TYPE_MEMBER_POSITION.
    
    queryOptions - Options dependent on the query type. For the query types (specified via queryType param) QUERY_TYPE_SEARCH/ QUERY_TYPE_WILDSEARCH you can specify one of the following query options: QUERY_OPTION_MEMBERSONLY, QUERY_OPTION_ALIASESONLY, QUERY_OPTION_MEMBERSANDALIASES. With any of the query type, you can combine QUERY_OPTION_COUNTONLY, QUERY_OPTION_NOTOTALCOUNTS QUERY_OPTION_INCLUDEHYBRIDANALYSIS, QUERY_OPTION_EXCLUDEHYBRIDANALYSIS, QUERY_OPTION_FORCECASESENSITIVE, QUERY_OPTION_FORCEIGNORECASE, QUERY_OPTION_UNIQUENAME, QUERY_OPTION_USESUBSTITUTIONVAR.
    
    dimName - Dimension to limit the scope of the query. It is used with the following query options and ignored otherwise: QUERY_TYPE_NAMEDGENERATION, QUERY_TYPE_NAMEDLEVEL, QUERY_TYPE_USERATTRIBUTE QUERY_TYPE_SEARCH (set to NULL to search through all dimensions), QUERY_TYPE_WILDSEARCH (set to NULL to search through all dimensions).
    
    input1 - Input string that is determined by the option. It is used with the following query options and ignored otherwise: QUERY_TYPE_NAMEDGENERATION (The name of the generation), QUERY_TYPE_NAMEDLEVEL (The name of the level), QUERY_TYPE_SEARCH (The string to search for. The string is defined as an exact), QUERY_TYPE_WILDSEARCH (The string to search for. The string is defined as an exact search string with an optional '*' at the end to mean any set of characters), QUERY_TYPE_USERATTRIBUTE (The user defined attribute).
    
    input2 - Input string that is determined by the option. It is used with the following query options and ignored otherwise: QUERY_TYPE_USERATTRIBUTE (The user defined attribute), QUERY_TYPE_SEARCH, QUERY_TYPE_WILDSEARCH (If the options are set to look in the alias tables, this string specifies the alias table to search in. If it's null, all alias tables will be searched).
    
    Returns:
    
    Iterator to iterate over the result.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - executeQuery
```
IEssIterator executeQuery(java.lang.String fieldSelection,
                          java.lang.String mbrSelection)
                   throws com.essbase.api.base.EssException
```
    Deprecated. Use IEssMemberSelection.executeQuery(String, String).
    
    Member selection over outline. Refer to IEssMemberSelection.executeQuery for more description.
    
    Parameters:
    
    fieldSelection - The query string which defines the set of fields that will be returned for each member. The syntax is "<OutputType Binary | Text <SelectMbrInfo ( FieldName {, FieldName}, ... )" where FieldName is one of the following: MemberName (Member name), MemberLevel (Member level number), MemberGeneration (Member generation number), Consolidation (Whether this member is consolidated), TwoPass (Whether this member undergoes a two pass operation), Expense (Whether this is an expense member), CurrencyConvType (Currency conversion type), CurrencyMember (Whether this is a currency member), TimeBalance (Time balance measure), SkipOption (Whether this member skips the time balance operation), ShareOption (Whether this is a shared member), StorageType (Dimension's storage type), DimensionCategory (Dimension category: accounts, time, currency, etc.), DimensionStorageCategory (Dimension storage category: time, units, scenario, etc.), Comment (Member comment), ChildrenCount (Number of children), MemberNumber (Member number), DimensionName (Dimension name), DimensionNumber (Dimension number), MemberAliasName (Alias for this member), ParentMemberName (Parent's name), ChildMemberName (Child's name), PreviousMemberName (Left sibling's name), NextMemberName (Right sibling's name), CurrencyConversionDatabase (Whether this database has currency conversion), MemberStatus (Member status), UDAList (List of UDAs attached to this member), MemberFormula (Formula for this member), MemberValidity (Whether this member is valid), AttrDimensionNames (Attribute dimensions associated with this member's dimension), MemberAttributed (Whether this member is attributed), AttributeDataType (Attribute data type for this member), AttributeDataValue (Attribute data value for this member), FormatString (Format String associated with this member).
    
    mbrSelection - The query string which defines the set of members to be returned. The syntax of this query string is the syntax for member selection; that is, the query string can be anything that you can use in a FIX() statement.
    
    Returns:
    
    Iterator to iterate over the result.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getCube
```
IEssCube getCube()
          throws com.essbase.api.base.EssException
```
    Gets the parent cube.
    
    Returns:
    
    The cube.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - dimensionHasHybridChildren
```
boolean dimensionHasHybridChildren()
                            throws com.essbase.api.base.EssException
```
    Checks if the outline has any relational descedents.
    
    Returns:
    
    boolean
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getQueryHintsCount
```
int getQueryHintsCount()
                throws com.essbase.api.base.EssException
```
    Gets the number of query hints associated with the outline.
    
    Returns:
    
    int
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getQueryHintsSize
```
int getQueryHintsSize()
               throws com.essbase.api.base.EssException
```
    Gets the count of members in query hints associated with the outline.
    
    Returns:
    
    int
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - addQueryHint
```
void addQueryHint(IEssMember[] memberArray)
           throws com.essbase.api.base.EssException
```
    Adds a query hint to the outline.
    
    Parameters:
    
    memberArray - The member array to associate with the query hint.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - deleteQueryHint
```
void deleteQueryHint(int hintNumber)
              throws com.essbase.api.base.EssException
```
    Deletes a query hint from the outline.
    
    Parameters:
    
    hintNumber - The hint number to delete.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getQueryHint
```
IEssIterator getQueryHint(int hintNumber,
                          int numMembers)
                   throws com.essbase.api.base.EssException
```
    Gets the members associated with a query hint from the outline.
    
    Parameters:
    
    hintNumber - The hint number to delete.
    
    numMembers - The number of members to get.
    
    Returns:
    
    An iterator of IEssMember objects.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setQueryHint
```
void setQueryHint(int hintNumber,
                  IEssMember[] memberArray)
           throws com.essbase.api.base.EssException
```
    Sets the members associated with a query hint in the outline.
    
    Parameters:
    
    hintNumber - The hint number to delete.
    
    memberArray - The member array to associate with the query hint.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getASOCompressionDimension
```
IEssDimension getASOCompressionDimension()
                                  throws com.essbase.api.base.EssException
```
    Gets the compression dimension in an ASO cube outline.
    
    Returns:
    
    The compression dimension.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - setASOCompressionDimension
```
void setASOCompressionDimension(IEssDimension dim)
                         throws com.essbase.api.base.EssException
```
    Sets the compression dimension in an ASO cube outline.
    
    Parameters:
    
    dim - The dimension to set as a compression dim.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getServerDateFormats
```
java.lang.String[][] getServerDateFormats(java.lang.String essbaseLocaleString)
                                   throws com.essbase.api.base.EssException
```
    Gets the date formats supported by Essbase Server.
    
    Parameters:
    
    essbaseLocaleString - A locale string in Essbase Server format (in ESSLANG format e.g. German_Germany.ISO-8859-15@Default)
    
    Returns:
    
    A two dimensional array of Strings. Each row of the array has two elements: the first element shows the format string and the second element shows an example of how the formatted date will look like.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - createSmartList
```
IEssSmartList createSmartList(java.lang.String smartListName)
                       throws com.essbase.api.base.EssException
```
    Creates a smartlist and retruns its instance.
    
    Parameters:
    
    smartListName - - Name of the smartlist to be created.
    
    Returns:
    
    an instance of the newly created smartlist.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - findSmartList
```
IEssSmartList findSmartList(java.lang.String smartListName)
                     throws com.essbase.api.base.EssException
```
    Finds a smartlist in the outline and returns its instance. If does not find any smartlist, an EssException will be thrown.
    
    Parameters:
    
    smartListName - The name of the smart list.
    
    Returns:
    
    instance of the smartlist if found.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs or smartlist not found.
  - getSmartListInfo
```
IEssSmartList getSmartListInfo(IEssSmartList smartList)
                        throws com.essbase.api.base.EssException
```
    Returns the smartlist instance containing the smartlist info.
    
    Parameters:
    
    smartList - - smartlist whos information is to be retrieved.
    
    Returns:
    
    the smartlist instance containing the smartlist info.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getAllSmartLists
```
IEssSmartList[] getAllSmartLists()
                          throws com.essbase.api.base.EssException
```
    Returns list of all smartlist for the given outline.
    
    Returns:
    
    list of all smartlist for the given outline.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getDateFormatString
```
java.lang.String getDateFormatString()
                              throws com.essbase.api.base.EssException
```
    Gets Date Format String.
    
    Returns:
    
    Date Format String.
    
    Throws:
    
    com.essbase.api.base.EssException - If an error occurs.
  - setDateFormatString
```
void setDateFormatString(java.lang.String dateFormatString)
                  throws com.essbase.api.base.EssException
```
    Sets the Date Format String.
    
    Parameters:
    
    dateFormatString - Date Format String to be set.
    
    Throws:
    
    com.essbase.api.base.EssException - If an error occurs
  - getAliasTableLanguages
```
java.lang.String[] getAliasTableLanguages(java.lang.String aliasTableName)
                                   throws com.essbase.api.base.EssException
```
    Gets the languages associated with the specified alias table
    
    Parameters:
    
    aliasTableName - - name of the alias table.
    
    Returns:
    
    the list of language codes for the given alias table as a String array.
    
    Throws:
    
    com.essbase.api.base.EssException - - If an error occurs.
    
    Since:
    
    11.1.2
  - setAliasTableLanguage
```
void setAliasTableLanguage(java.lang.String aliasTableName,
                           java.lang.String languageCode)
                    throws com.essbase.api.base.EssException
```
    Sets the language for the alias table. As there can be multiple languages associated with an alias table, this API effectively adds the given language code to the list of languages associated with that alias table.
    
    Parameters:
    
    aliasTableName - - name of the alias table whose language has to be set.
    
    languageCode - - language code of the language
    
    Throws:
    
    com.essbase.api.base.EssException - - If an error occurs.
    
    Since:
    
    11.1.2
  - clearAliasTableLanguage
```
void clearAliasTableLanguage(java.lang.String aliasTableName)
                      throws com.essbase.api.base.EssException
```
    Clears the languages for the alias table
    
    Parameters:
    
    aliasTableName - - name of the alias table whose languages have to be cleared.
    
    Throws:
    
    com.essbase.api.base.EssException - - If an error occurs.
    
    Since:
    
    11.1.2

Interface IEssCubeOutline

Nested Class Summary

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

Field Summary

Method Summary

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

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

Field Detail

PROP_NAME

PROP_CASE_SENSITIVE

PROP_OUTLINE_TYPE

PROP_AUTO_CONFIGURE

PROP_COUNT_ALIAS_TABLES

PROP_ALIAS_TABLE_NAMES

PROP_NON_UNIQUE_NAMES

s_countProperties

s_propNames

s_propDataTypes

s_propModes

ESS_OTL_NAME_UNIQUE

ESS_OTL_NAME_NONUNIQUE

ESS_OTL_NAME_BIUNIQUE

VERIFY_OPTION_NONE

VERIFY_OPTION_AllFORMULA

VERIFY_OPTION_SHAREDBEFOREPROTOTYPE

Method Detail

isCaseSensitive

setCaseSensitive

getOutlineType

setOutlineType

getOutlineNameType

setOutlineNameType

getOutlineVersion

getOPGVersion

isAutoConfigure

setAutoConfigure

isNonUniqueMemberNameEnabled

setNonUniqueMemberNameEnabled

isMemberTypeEnabled

setMemberTypeEnabled

getImpliedShare

setImpliedShare

isVaryingAttributeEnabled

getCountAliasTables

getAliasTableNames

isGenerationNameByPrefix

setGenerationNameByPrefix

getUseNameOf

setUseNameOf

getDelimiter

setDelimiter

getDateFormat

setDateFormat

getBucketingType

setBucketingType

getDefaultTrueString

setDefaultTrueString

getDefaultFalseString

setDefaultFalseString

getDefaultAttrCalcDimName

setDefaultAttrCalcDimName

getDefaultSumMbrName

setDefaultSumMbrName

getDefaultCountMbrName

setDefaultCountMbrName

getDefaultAverageMbrName

setDefaultAverageMbrName

getDefaultMinMbrName

setDefaultMinMbrName

getDefaultMaxMbrName

setDefaultMaxMbrName

refreshPropertyValues

updatePropertyValues

open

open

open

open

isOpen

getCountMemberOnTheFly

setCountMemberOnTheFly