com.essbase.api.metadata

Interface IEssMemberProperty

public interface IEssMemberProperty

IEssMemberProperty Interface

Author:

rudpatil

Field Summary

Fields

Modifier and Type	Field and Description
static short	ESS_MBRPROPDT_BOOL
static short	ESS_MBRPROPDT_DATE
static short	ESS_MBRPROPDT_ENUM
static short	ESS_MBRPROPDT_NUMBER
static short	ESS_MBRPROPDT_TEXT
static long	ESS_MBRPROPFLAG_PROPERTY_INDEXED
static long	ESS_MBRPROPFLAG_PROPERTY_SHARE
static long	ESS_MBRPROPFLAG_PROPERTY_UNIQUE
static short	OP_EQ Equal-to member property querying operator
static short	OP_GT Greater-Than member property querying operator
static short	OP_GTE Greater-Than-or-Equal-to member property querying operator
static short	OP_LT Less-Than member property querying operator
static short	OP_LTE Less-Than-or-Equal-to member property querying operator
static short	OP_NEQ Not-equal-to member property querying operator

Method Summary

Modifier and Type	Method and Description
void	addToEnumList(java.lang.String[] newValue) Add a new enum value(one or more) to the property.
void	delete(IEssDimension dimension) Delete the Property.
com.essbase.api.base.EssValueAny	getDefaultValue() Gets the property default value.
IEssDimension	getDimension() Gets the dimension for a property.
long	getFlags() Gets the property flags.
java.lang.String	getName() Gets the property name.
java.lang.String[]	getPropertyEnumList() Gets the list of enums for a property.
short	getType() Gets the property type.
void	rename(java.lang.String newName) Rename the Property.
void	renameEnumListItem(java.lang.String[] oldValue, java.lang.String[] newValue) Change an enum value(one or more) of a property.

Field Detail

ESS_MBRPROPDT_NUMBER

static final short ESS_MBRPROPDT_NUMBER

See Also:

Constant Field Values

ESS_MBRPROPDT_BOOL

static final short ESS_MBRPROPDT_BOOL

See Also:

Constant Field Values

ESS_MBRPROPDT_DATE

static final short ESS_MBRPROPDT_DATE

See Also:

Constant Field Values

ESS_MBRPROPDT_TEXT

static final short ESS_MBRPROPDT_TEXT

See Also:

Constant Field Values

ESS_MBRPROPDT_ENUM

static final short ESS_MBRPROPDT_ENUM

See Also:

Constant Field Values

ESS_MBRPROPFLAG_PROPERTY_INDEXED

static final long ESS_MBRPROPFLAG_PROPERTY_INDEXED

See Also:

Constant Field Values

ESS_MBRPROPFLAG_PROPERTY_SHARE

static final long ESS_MBRPROPFLAG_PROPERTY_SHARE

See Also:

Constant Field Values

ESS_MBRPROPFLAG_PROPERTY_UNIQUE

static final long ESS_MBRPROPFLAG_PROPERTY_UNIQUE

See Also:

Constant Field Values

OP_EQ

static final short OP_EQ

Equal-to member property querying operator

See Also:

Constant Field Values

OP_NEQ

static final short OP_NEQ

Not-equal-to member property querying operator

See Also:

Constant Field Values

OP_GT

static final short OP_GT

Greater-Than member property querying operator

See Also:

Constant Field Values

OP_LT

static final short OP_LT

Less-Than member property querying operator

See Also:

Constant Field Values

OP_GTE

static final short OP_GTE

Greater-Than-or-Equal-to member property querying operator

See Also:

Constant Field Values

OP_LTE

static final short OP_LTE

Less-Than-or-Equal-to member property querying operator

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                  throws com.essbase.api.base.EssException

Gets the property name.

Returns:

The property name.

Throws:

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

getType

short getType()
       throws com.essbase.api.base.EssException

Gets the property type.

Returns:

The property name.

Throws:

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

getDefaultValue

com.essbase.api.base.EssValueAny getDefaultValue()
                                          throws com.essbase.api.base.EssException

Gets the property default value.

Returns:

The property default value.

Throws:

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

getFlags

long getFlags()
       throws com.essbase.api.base.EssException

Gets the property flags.

Returns:

The property flags.

Throws:

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

addToEnumList

void addToEnumList(java.lang.String[] newValue)
            throws com.essbase.api.base.EssException

Add a new enum value(one or more) to the property.

Parameters:

newValue - New enum value

Throws:

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

renameEnumListItem

void renameEnumListItem(java.lang.String[] oldValue,
                        java.lang.String[] newValue)
                 throws com.essbase.api.base.EssException

Change an enum value(one or more) of a property.

Parameters:

oldValue - The old enum value

newValue - The new enum value

Throws:

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

rename

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

Rename the Property.

Parameters:

newName - New property name

Throws:

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

delete

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

Delete the Property.

Parameters:

dimension - The dimension for a property

Throws:

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

getPropertyEnumList

java.lang.String[] getPropertyEnumList()
                                throws com.essbase.api.base.EssException

Gets the list of enums for a property.

Returns:

The property enums.

Throws:

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

getDimension

IEssDimension getDimension()
                    throws com.essbase.api.base.EssException

Gets the dimension for a property.

Returns:

The dimension

Throws:

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