com.essbase.api.metadata

Interface IEssPropertyDefinition

public interface IEssPropertyDefinition

IEssPropertyDefinition Interface

Author:

rudpatil

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IEssPropertyDefinition.EEssSystemPropertyTags

Field Summary

Fields

Modifier and Type	Field and Description
static short	ESS_MBRPROP_DT_BOOL
static short	ESS_MBRPROP_DT_DATETIME
static short	ESS_MBRPROP_DT_NUMBER
static short	ESS_MBRPROP_DT_TEXT
static int	ESS_MBRPROPFLAG_PROPERTY_CACHED
static int	ESS_MBRPROPFLAG_PROPERTY_INDEXED
static int	ESS_MBRPROPFLAG_PROPERTY_SHARE
static int	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
com.essbase.api.base.EssValueAny	getDefaultValue() Gets the property default value.
IEssDimension	getDimension() Gets the dimension for a property.
int	getFlags() Gets the property flags.
java.lang.String	getName() Gets the property name.
int	getType() Gets the property type.
void	rename(java.lang.String newName) Rename the Property.
void	setDefaultValue(IEssValueAny defaultValue) Set Default value for property.
void	setFlags(int flags) Set Property Flags Below types are supported IEssMembeProperty.ESS_MBRPROPFLAG_PROPERTY_INDEXED, IEssMembeProperty.ESS_MBRPROPFLAG_PROPERTY_SHARE or IEssMembeProperty.ESS_MBRPROPFLAG_PROPERTY_UNIQUE.
void	update() Updates the property Definition.

Field Detail

ESS_MBRPROP_DT_NUMBER

static final short ESS_MBRPROP_DT_NUMBER

See Also:

Constant Field Values

ESS_MBRPROP_DT_BOOL

static final short ESS_MBRPROP_DT_BOOL

See Also:

Constant Field Values

ESS_MBRPROP_DT_TEXT

static final short ESS_MBRPROP_DT_TEXT

See Also:

Constant Field Values

ESS_MBRPROP_DT_DATETIME

static final short ESS_MBRPROP_DT_DATETIME

See Also:

Constant Field Values

ESS_MBRPROPFLAG_PROPERTY_SHARE

static final int ESS_MBRPROPFLAG_PROPERTY_SHARE

See Also:

Constant Field Values

ESS_MBRPROPFLAG_PROPERTY_UNIQUE

static final int ESS_MBRPROPFLAG_PROPERTY_UNIQUE

See Also:

Constant Field Values

ESS_MBRPROPFLAG_PROPERTY_CACHED

static final int ESS_MBRPROPFLAG_PROPERTY_CACHED

See Also:

Constant Field Values

ESS_MBRPROPFLAG_PROPERTY_INDEXED

static final int ESS_MBRPROPFLAG_PROPERTY_INDEXED

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

int 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.

setDefaultValue

void setDefaultValue(IEssValueAny defaultValue)
              throws com.essbase.api.base.EssException

Set Default value for property. The changes made to this object by setDefaultValue() method will become effective only after you invoke update()

Parameters:

defaultValue - The Dimension Member Properties supports only the below types, Text, Boolean, Number or Date eg. IEssValueAny defaultValue = new EssValueAny(); defaultValue.setDouble(value); defaultValue.setDate(dataValue); defaultValue.setBoolean(boolValue); defaultValue.setString(strValue);

Throws:

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

getFlags

int 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.

setFlags

void setFlags(int flags)
       throws com.essbase.api.base.EssException

Set Property Flags Below types are supported IEssMembeProperty.ESS_MBRPROPFLAG_PROPERTY_INDEXED, IEssMembeProperty.ESS_MBRPROPFLAG_PROPERTY_SHARE or IEssMembeProperty.ESS_MBRPROPFLAG_PROPERTY_UNIQUE. The changes made to this object by setFlags() method will become effective only after you invoke update()

Parameters:

flags - The number of flag to be set.

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. The changes made to this object by rename() method will become effective only after you invoke update()

Parameters:

newName - New property name

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.

update

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

Updates the property Definition. The changes made to this object via rename(), setFlags(), setDefaultValue() methods will become effective only after you invoke update.

Throws:

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