Skip navigation links


com.essbase.eas.essbase.defs
Class Definitions

java.lang.Object
  extended by com.essbase.eas.essbase.defs.Definitions


public class Definitions
extends java.lang.Object

Contains specifications of values for essbase compatibility. Can be compared to the essapi.h file for the C API. This class consists of groups of defined constants and inner classes designed to retrieve the correct localized string for each different set of values.

Version:
1.00, 10/25/2000
Author:
Hank Cox

Nested Class Summary
static class Definitions.CalculationState
           
static class Definitions.DatabaseTypes
           
static class Definitions.DataStorage
           
static class Definitions.LoadStatus
           
static class Definitions.Permissions
           

 

Field Summary
static short ACCESS_APPALL
           
static short ACCESS_APPCREATE
           
static short ACCESS_APPDESIGN
           
static short ACCESS_CALC
           
static short ACCESS_DBALL
           
static short ACCESS_DBCREATE
           
static short ACCESS_DBDESIGN
           
static short ACCESS_FILTER
           
static short ACCESS_NONE
           
static short ACCESS_READ
           
static short ACCESS_SUPER
           
static short ACCESS_WRITE
           
static short ALIASNAMELEN
           
static short APPLICATION_ESSBASE
           
static short APPLICATION_HFM
           
static short APPLICATION_PLANNING
           
static short APPLICATION_TYPE_ALL
           
static short APPLICATION_TYPE_ASO
           
static short APPLICATION_TYPE_DEFAULT
           
static short APPLICATION_TYPE_DSO
           
static short APPNAMELEN
           
static long ASODISKMAX_SIZE
           
static long ASOFILEMAX_SIZE
           
static short ATTRIBUTELEN
           
static short ATTRMBRDT_AUTO
           
static short ATTRMBRDT_BOOL
           
static short ATTRMBRDT_DATETIME
           
static short ATTRMBRDT_DOUBLE
           
static short ATTRMBRDT_NONE
           
static short ATTRMBRDT_STRING
           
static short CAT_ACCOUNTS
           
static short CAT_ATTRCALC
           
static short CAT_ATTRIBUTE
           
static short CAT_COUNTRY
           
static short CAT_CURPARTITION
           
static short CAT_NONE
           
static short CAT_TIME
           
static short CAT_TYPE
           
static java.lang.String CLOSE
           
static short COMP_BITMAP
           
static short COMP_RUNLENGTH
           
static short CONV_CATEGORY
           
static short CONV_NOCONV
           
static short CONV_NONE
           
static short CRCTYPE_DIV
           
static short CRCTYPE_MULT
           
static short DATA_STORAGE_DB2RELATIONAL
           
static short DATA_STORAGE_DEFAULT
           
static short DATA_STORAGE_MULTIDIM
           
static short DATA_STORAGE_ORACLERELATIONAL
           
static short DATA_STORAGE_UNDEFINED
           
static short DBCALCSTATE_CLEAN
           
static short DBCALCSTATE_LOADNOCALC
           
static short DBCALCSTATE_NONE
           
static short DBCOMPRESSIONTYPE_BITMAP
           
static short DBCOMPRESSIONTYPE_NONE
           
static short DBCOMPRESSIONTYPE_RLE
           
static short DBNAMELEN
           
static long DBREQFLAG_CALCDEF
           
static long DBREQFLAG_CALCSCR
           
static long DBREQTYPE_CALC
           
static long DBREQTYPE_DATLOAD
           
static long DBREQTYPE_OTLUPD
           
static short DBTYPE_CURRENCY
           
static short DBTYPE_NORMAL
           
static short DBTYPE_NORMAL_ASO
           
static java.lang.String DEFAULT
           
static short DESCLEN
           
static short DIMTYPE_DENSE
           
static short DIMTYPE_SPARSE
           
static short DOMAIN_ACCESS_BOTH
           
static short DOMAIN_ACCESS_ESSBASE_ONLY
           
static short DOMAIN_ACCESS_NONE
           
static short DOMAIN_ACCESS_PLANNING_INTERNAL
           
static short DOMAIN_ACCESS_PLANNING_ONLY
           
static short ERRORSTRLEN
           
static long FILEMAX_SIZE
           
static long FILEMIN_SIZE
           
static short FILENAMELEN
           
static short FILETYPE_DATA
           
static short FILETYPE_INDEX
           
static short FTRNAMELEN
           
static short INDEXTYPE_ARRAY
           
static short INDEXTYPE_AVL
           
static short ISOLATION_COMMITTED
           
static short ISOLATION_UNCOMMITTED
           
static short MBRCOMMENTEXLEN
           
static short MBRCOMMENTLEN
           
static short MBRNAMELEN
           
static short MINPASSWORDLEN
           
static java.lang.String NAME_PROVIDER_SEPARATOR
           
static short OBJNAMELEN
           
static java.lang.String OPEN
           
static double PARTITIONMAX_SIZE
           
static double PARTITIONMIN_SIZE
           
static short PASSWORDLEN
           
static short PRIV_APPCREATE
           
static short PRIV_APPDESIGN
           
static short PRIV_APPLOAD
           
static short PRIV_CALC
           
static short PRIV_DBCREATE
           
static short PRIV_DBDESIGN
           
static short PRIV_DBLOAD
           
static short PRIV_NONE
           
static short PRIV_READ
           
static short PRIV_USERCREATE
           
static short PRIV_WRITE
           
static short SHARE_DATA
           
static short SHARE_DYNCALCNOSTORE
           
static short SHARE_DYNCALCSTORE
           
static short SHARE_LABEL
           
static short SHARE_NEVER
           
static short SHARE_SHARE
           
static short SKIP_BOTH
           
static short SKIP_MISSING
           
static short SKIP_NONE
           
static short SKIP_ZEROS
           
static short STATUS_LOADED
           
static short STATUS_LOADING
           
static short STATUS_NOTLOADED
           
static short STATUS_UNLOADING
           
static short STORECAT_ACCOUNTS
           
static short STORECAT_ATTRCALC
           
static short STORECAT_ATTRIBUTE
           
static short STORECAT_BUSUNIT
           
static short STORECAT_CUSTOMER
           
static short STORECAT_DIST
           
static short STORECAT_GEOG
           
static short STORECAT_MARKET
           
static short STORECAT_ORGAN
           
static short STORECAT_OTHER
           
static short STORECAT_PRODUCT
           
static short STORECAT_SCENARIO
           
static short STORECAT_TIME
           
static short STORECAT_UNITS
           
static short SVRNAMELEN
           
static short TIMEBAL_AVG
           
static short TIMEBAL_FIRST
           
static short TIMEBAL_LAST
           
static short TIMEBAL_NONE
           
static short TYPE_GROUP
           
static short TYPE_NONE
           
static short TYPE_USER
           
static short UCALC_ADD
           
static short UCALC_DIV
           
static short UCALC_MULT
           
static short UCALC_NOOP
           
static short UCALC_PERCENT
           
static short UCALC_SUB
           
static java.lang.String UNLIMITED
           
static short USER_CSS
           
static short USER_EXTERNAL
           
static short USER_INTERNAL
           
static java.lang.String USER_PROTOCOL_CSS
           
static short USERNAMELEN
           
static short USERNAMELEN_11X
           
static short VARVALUELEN
           

 

Method Summary
static Definitions.CalculationState createCalculationState()
           
static Definitions.DatabaseTypes createDatabaseTypes()
           
static Definitions.DataStorage createDataStorage()
           
static Definitions.LoadStatus createLoadStatus()
           
static Definitions.Permissions createPermissions()
           
static java.lang.String getDefinedString(long[] candidates, java.lang.String[] suffixes, java.lang.String prefix, long value)
          retrieves a translated string to represent some value in the essbase universe.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

DBCALCSTATE_NONE

public static final short DBCALCSTATE_NONE
See Also:
Constant Field Values

DBCALCSTATE_LOADNOCALC

public static final short DBCALCSTATE_LOADNOCALC
See Also:
Constant Field Values

DBCALCSTATE_CLEAN

public static final short DBCALCSTATE_CLEAN
See Also:
Constant Field Values

STATUS_NOTLOADED

public static final short STATUS_NOTLOADED
See Also:
Constant Field Values

STATUS_LOADING

public static final short STATUS_LOADING
See Also:
Constant Field Values

STATUS_LOADED

public static final short STATUS_LOADED
See Also:
Constant Field Values

STATUS_UNLOADING

public static final short STATUS_UNLOADING
See Also:
Constant Field Values

APPLICATION_TYPE_ASO

public static final short APPLICATION_TYPE_ASO
See Also:
Constant Field Values

APPLICATION_TYPE_DSO

public static final short APPLICATION_TYPE_DSO
See Also:
Constant Field Values

APPLICATION_TYPE_DEFAULT

public static final short APPLICATION_TYPE_DEFAULT
See Also:
Constant Field Values

APPLICATION_TYPE_ALL

public static final short APPLICATION_TYPE_ALL
See Also:
Constant Field Values

APPLICATION_ESSBASE

public static final short APPLICATION_ESSBASE
See Also:
Constant Field Values

APPLICATION_PLANNING

public static final short APPLICATION_PLANNING
See Also:
Constant Field Values

APPLICATION_HFM

public static final short APPLICATION_HFM
See Also:
Constant Field Values

DATA_STORAGE_MULTIDIM

public static final short DATA_STORAGE_MULTIDIM
See Also:
Constant Field Values

DATA_STORAGE_DEFAULT

public static final short DATA_STORAGE_DEFAULT
See Also:
Constant Field Values

DATA_STORAGE_DB2RELATIONAL

public static final short DATA_STORAGE_DB2RELATIONAL
See Also:
Constant Field Values

DATA_STORAGE_ORACLERELATIONAL

public static final short DATA_STORAGE_ORACLERELATIONAL
See Also:
Constant Field Values

DATA_STORAGE_UNDEFINED

public static final short DATA_STORAGE_UNDEFINED
See Also:
Constant Field Values

PRIV_NONE

public static final short PRIV_NONE
See Also:
Constant Field Values

PRIV_READ

public static final short PRIV_READ
See Also:
Constant Field Values

PRIV_WRITE

public static final short PRIV_WRITE
See Also:
Constant Field Values

PRIV_CALC

public static final short PRIV_CALC
See Also:
Constant Field Values

PRIV_DBLOAD

public static final short PRIV_DBLOAD
See Also:
Constant Field Values

PRIV_DBDESIGN

public static final short PRIV_DBDESIGN
See Also:
Constant Field Values

PRIV_DBCREATE

public static final short PRIV_DBCREATE
See Also:
Constant Field Values

PRIV_APPLOAD

public static final short PRIV_APPLOAD
See Also:
Constant Field Values

PRIV_APPDESIGN

public static final short PRIV_APPDESIGN
See Also:
Constant Field Values

PRIV_APPCREATE

public static final short PRIV_APPCREATE
See Also:
Constant Field Values

PRIV_USERCREATE

public static final short PRIV_USERCREATE
See Also:
Constant Field Values

ACCESS_NONE

public static final short ACCESS_NONE
See Also:
Constant Field Values

ACCESS_READ

public static final short ACCESS_READ
See Also:
Constant Field Values

ACCESS_WRITE

public static final short ACCESS_WRITE
See Also:
Constant Field Values

ACCESS_CALC

public static final short ACCESS_CALC
See Also:
Constant Field Values

ACCESS_DBDESIGN

public static final short ACCESS_DBDESIGN
See Also:
Constant Field Values

ACCESS_DBCREATE

public static final short ACCESS_DBCREATE
See Also:
Constant Field Values

ACCESS_APPDESIGN

public static final short ACCESS_APPDESIGN
See Also:
Constant Field Values

ACCESS_APPCREATE

public static final short ACCESS_APPCREATE
See Also:
Constant Field Values

ACCESS_FILTER

public static final short ACCESS_FILTER
See Also:
Constant Field Values

ACCESS_DBALL

public static final short ACCESS_DBALL
See Also:
Constant Field Values

ACCESS_APPALL

public static final short ACCESS_APPALL
See Also:
Constant Field Values

ACCESS_SUPER

public static final short ACCESS_SUPER
See Also:
Constant Field Values

DOMAIN_ACCESS_NONE

public static final short DOMAIN_ACCESS_NONE
See Also:
Constant Field Values

DOMAIN_ACCESS_ESSBASE_ONLY

public static final short DOMAIN_ACCESS_ESSBASE_ONLY
See Also:
Constant Field Values

DOMAIN_ACCESS_PLANNING_ONLY

public static final short DOMAIN_ACCESS_PLANNING_ONLY
See Also:
Constant Field Values

DOMAIN_ACCESS_PLANNING_INTERNAL

public static final short DOMAIN_ACCESS_PLANNING_INTERNAL
See Also:
Constant Field Values

DOMAIN_ACCESS_BOTH

public static final short DOMAIN_ACCESS_BOTH
See Also:
Constant Field Values

CRCTYPE_DIV

public static final short CRCTYPE_DIV
See Also:
Constant Field Values

CRCTYPE_MULT

public static final short CRCTYPE_MULT
See Also:
Constant Field Values

PARTITIONMIN_SIZE

public static final double PARTITIONMIN_SIZE
See Also:
Constant Field Values

PARTITIONMAX_SIZE

public static final double PARTITIONMAX_SIZE
See Also:
Constant Field Values

UNLIMITED

public static final java.lang.String UNLIMITED
See Also:
Constant Field Values

DEFAULT

public static final java.lang.String DEFAULT
See Also:
Constant Field Values

OPEN

public static final java.lang.String OPEN
See Also:
Constant Field Values

CLOSE

public static final java.lang.String CLOSE
See Also:
Constant Field Values

FILEMIN_SIZE

public static final long FILEMIN_SIZE
See Also:
Constant Field Values

FILEMAX_SIZE

public static final long FILEMAX_SIZE
See Also:
Constant Field Values

ASOFILEMAX_SIZE

public static final long ASOFILEMAX_SIZE
See Also:
Constant Field Values

ASODISKMAX_SIZE

public static final long ASODISKMAX_SIZE
See Also:
Constant Field Values

FILETYPE_INDEX

public static final short FILETYPE_INDEX
See Also:
Constant Field Values

FILETYPE_DATA

public static final short FILETYPE_DATA
See Also:
Constant Field Values

ISOLATION_COMMITTED

public static final short ISOLATION_COMMITTED
See Also:
Constant Field Values

ISOLATION_UNCOMMITTED

public static final short ISOLATION_UNCOMMITTED
See Also:
Constant Field Values

INDEXTYPE_ARRAY

public static final short INDEXTYPE_ARRAY
See Also:
Constant Field Values

INDEXTYPE_AVL

public static final short INDEXTYPE_AVL
See Also:
Constant Field Values

DBCOMPRESSIONTYPE_NONE

public static final short DBCOMPRESSIONTYPE_NONE
See Also:
Constant Field Values

DBCOMPRESSIONTYPE_RLE

public static final short DBCOMPRESSIONTYPE_RLE
See Also:
Constant Field Values

DBCOMPRESSIONTYPE_BITMAP

public static final short DBCOMPRESSIONTYPE_BITMAP
See Also:
Constant Field Values

DIMTYPE_DENSE

public static final short DIMTYPE_DENSE
See Also:
Constant Field Values

DIMTYPE_SPARSE

public static final short DIMTYPE_SPARSE
See Also:
Constant Field Values

DBTYPE_NORMAL

public static final short DBTYPE_NORMAL
See Also:
Constant Field Values

DBTYPE_CURRENCY

public static final short DBTYPE_CURRENCY
See Also:
Constant Field Values

DBTYPE_NORMAL_ASO

public static final short DBTYPE_NORMAL_ASO
See Also:
Constant Field Values

UCALC_ADD

public static final short UCALC_ADD
See Also:
Constant Field Values

UCALC_SUB

public static final short UCALC_SUB
See Also:
Constant Field Values

UCALC_MULT

public static final short UCALC_MULT
See Also:
Constant Field Values

UCALC_DIV

public static final short UCALC_DIV
See Also:
Constant Field Values

UCALC_PERCENT

public static final short UCALC_PERCENT
See Also:
Constant Field Values

UCALC_NOOP

public static final short UCALC_NOOP
See Also:
Constant Field Values

CONV_NONE

public static final short CONV_NONE
See Also:
Constant Field Values

CONV_CATEGORY

public static final short CONV_CATEGORY
See Also:
Constant Field Values

CONV_NOCONV

public static final short CONV_NOCONV
See Also:
Constant Field Values

TIMEBAL_NONE

public static final short TIMEBAL_NONE
See Also:
Constant Field Values

TIMEBAL_FIRST

public static final short TIMEBAL_FIRST
See Also:
Constant Field Values

TIMEBAL_LAST

public static final short TIMEBAL_LAST
See Also:
Constant Field Values

TIMEBAL_AVG

public static final short TIMEBAL_AVG
See Also:
Constant Field Values

SKIP_NONE

public static final short SKIP_NONE
See Also:
Constant Field Values

SKIP_MISSING

public static final short SKIP_MISSING
See Also:
Constant Field Values

SKIP_ZEROS

public static final short SKIP_ZEROS
See Also:
Constant Field Values

SKIP_BOTH

public static final short SKIP_BOTH
See Also:
Constant Field Values

SHARE_DATA

public static final short SHARE_DATA
See Also:
Constant Field Values

SHARE_NEVER

public static final short SHARE_NEVER
See Also:
Constant Field Values

SHARE_LABEL

public static final short SHARE_LABEL
See Also:
Constant Field Values

SHARE_SHARE

public static final short SHARE_SHARE
See Also:
Constant Field Values

SHARE_DYNCALCSTORE

public static final short SHARE_DYNCALCSTORE
See Also:
Constant Field Values

SHARE_DYNCALCNOSTORE

public static final short SHARE_DYNCALCNOSTORE
See Also:
Constant Field Values

CAT_NONE

public static final short CAT_NONE
See Also:
Constant Field Values

CAT_ACCOUNTS

public static final short CAT_ACCOUNTS
See Also:
Constant Field Values

CAT_TIME

public static final short CAT_TIME
See Also:
Constant Field Values

CAT_COUNTRY

public static final short CAT_COUNTRY
See Also:
Constant Field Values

CAT_TYPE

public static final short CAT_TYPE
See Also:
Constant Field Values

CAT_CURPARTITION

public static final short CAT_CURPARTITION
See Also:
Constant Field Values

CAT_ATTRIBUTE

public static final short CAT_ATTRIBUTE
See Also:
Constant Field Values

CAT_ATTRCALC

public static final short CAT_ATTRCALC
See Also:
Constant Field Values

STORECAT_OTHER

public static final short STORECAT_OTHER
See Also:
Constant Field Values

STORECAT_TIME

public static final short STORECAT_TIME
See Also:
Constant Field Values

STORECAT_UNITS

public static final short STORECAT_UNITS
See Also:
Constant Field Values

STORECAT_SCENARIO

public static final short STORECAT_SCENARIO
See Also:
Constant Field Values

STORECAT_ACCOUNTS

public static final short STORECAT_ACCOUNTS
See Also:
Constant Field Values

STORECAT_PRODUCT

public static final short STORECAT_PRODUCT
See Also:
Constant Field Values

STORECAT_ORGAN

public static final short STORECAT_ORGAN
See Also:
Constant Field Values

STORECAT_MARKET

public static final short STORECAT_MARKET
See Also:
Constant Field Values

STORECAT_CUSTOMER

public static final short STORECAT_CUSTOMER
See Also:
Constant Field Values

STORECAT_DIST

public static final short STORECAT_DIST
See Also:
Constant Field Values

STORECAT_BUSUNIT

public static final short STORECAT_BUSUNIT
See Also:
Constant Field Values

STORECAT_GEOG

public static final short STORECAT_GEOG
See Also:
Constant Field Values

STORECAT_ATTRIBUTE

public static final short STORECAT_ATTRIBUTE
See Also:
Constant Field Values

STORECAT_ATTRCALC

public static final short STORECAT_ATTRCALC
See Also:
Constant Field Values

ATTRMBRDT_DOUBLE

public static final short ATTRMBRDT_DOUBLE
See Also:
Constant Field Values

ATTRMBRDT_BOOL

public static final short ATTRMBRDT_BOOL
See Also:
Constant Field Values

ATTRMBRDT_DATETIME

public static final short ATTRMBRDT_DATETIME
See Also:
Constant Field Values

ATTRMBRDT_STRING

public static final short ATTRMBRDT_STRING
See Also:
Constant Field Values

ATTRMBRDT_NONE

public static final short ATTRMBRDT_NONE
See Also:
Constant Field Values

ATTRMBRDT_AUTO

public static final short ATTRMBRDT_AUTO
See Also:
Constant Field Values

DBREQTYPE_DATLOAD

public static final long DBREQTYPE_DATLOAD
See Also:
Constant Field Values

DBREQTYPE_CALC

public static final long DBREQTYPE_CALC
See Also:
Constant Field Values

DBREQTYPE_OTLUPD

public static final long DBREQTYPE_OTLUPD
See Also:
Constant Field Values

DBREQFLAG_CALCDEF

public static final long DBREQFLAG_CALCDEF
See Also:
Constant Field Values

DBREQFLAG_CALCSCR

public static final long DBREQFLAG_CALCSCR
See Also:
Constant Field Values

COMP_RUNLENGTH

public static final short COMP_RUNLENGTH
See Also:
Constant Field Values

COMP_BITMAP

public static final short COMP_BITMAP
See Also:
Constant Field Values

USERNAMELEN

public static final short USERNAMELEN
See Also:
Constant Field Values

USERNAMELEN_11X

public static final short USERNAMELEN_11X
See Also:
Constant Field Values

PASSWORDLEN

public static final short PASSWORDLEN
See Also:
Constant Field Values

MINPASSWORDLEN

public static final short MINPASSWORDLEN
See Also:
Constant Field Values

SVRNAMELEN

public static final short SVRNAMELEN
See Also:
Constant Field Values

APPNAMELEN

public static final short APPNAMELEN
See Also:
Constant Field Values

DBNAMELEN

public static final short DBNAMELEN
See Also:
Constant Field Values

OBJNAMELEN

public static final short OBJNAMELEN
See Also:
Constant Field Values

MBRNAMELEN

public static final short MBRNAMELEN
See Also:
Constant Field Values

FTRNAMELEN

public static final short FTRNAMELEN
See Also:
Constant Field Values

ALIASNAMELEN

public static final short ALIASNAMELEN
See Also:
Constant Field Values

DESCLEN

public static final short DESCLEN
See Also:
Constant Field Values

FILENAMELEN

public static final short FILENAMELEN
See Also:
Constant Field Values

VARVALUELEN

public static final short VARVALUELEN
See Also:
Constant Field Values

MBRCOMMENTLEN

public static final short MBRCOMMENTLEN
See Also:
Constant Field Values

MBRCOMMENTEXLEN

public static final short MBRCOMMENTEXLEN
See Also:
Constant Field Values

ERRORSTRLEN

public static final short ERRORSTRLEN
See Also:
Constant Field Values

ATTRIBUTELEN

public static final short ATTRIBUTELEN
See Also:
Constant Field Values

USER_INTERNAL

public static final short USER_INTERNAL
See Also:
Constant Field Values

USER_EXTERNAL

public static final short USER_EXTERNAL
See Also:
Constant Field Values

USER_CSS

public static final short USER_CSS
See Also:
Constant Field Values

USER_PROTOCOL_CSS

public static final java.lang.String USER_PROTOCOL_CSS
See Also:
Constant Field Values

TYPE_NONE

public static final short TYPE_NONE
See Also:
Constant Field Values

TYPE_USER

public static final short TYPE_USER
See Also:
Constant Field Values

TYPE_GROUP

public static final short TYPE_GROUP
See Also:
Constant Field Values

NAME_PROVIDER_SEPARATOR

public static final java.lang.String NAME_PROVIDER_SEPARATOR
See Also:
Constant Field Values

Method Detail

getDefinedString

public static java.lang.String getDefinedString(long[] candidates,
                                                java.lang.String[] suffixes,
                                                java.lang.String prefix,
                                                long value)
retrieves a translated string to represent some value in the essbase universe. The candidates and suffixes arrays must be the same length or the unknown value will be returned
Parameters:
candidates - - list of possible candidate values.
suffixes - - suffix for each of the candidate values.
prefix - - the prefix in the resource file for this set of keys.
value - - the value to try to retrieve.

createCalculationState

public static Definitions.CalculationState createCalculationState()

createLoadStatus

public static Definitions.LoadStatus createLoadStatus()

createDataStorage

public static Definitions.DataStorage createDataStorage()

createPermissions

public static Definitions.Permissions createPermissions()

createDatabaseTypes

public static Definitions.DatabaseTypes createDatabaseTypes()

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.