Skip navigation links


com.essbase.api.base
Interface IEssValueAny

All Superinterfaces:
IEssBaseObject

public interface IEssValueAny
extends IEssBaseObject

The IEssValueAny interface.

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

Nested Class Summary
static class IEssValueAny.EEssDataType
          The EEssDataType class is an enumeration of data types.

 

Method Summary
 boolean getBoolean()
          Gets the boolean value.
 IEssValueAny.EEssDataType getDataType()
          Gets the data type of the value.
 java.util.Date getDate()
          Gets the Date value.
 double getDouble()
          Gets the double value.
 IEssEnum getEssEnum()
          Gets the IEssEnum value.
 float getFloat()
          Gets the float value.
 int getInt()
          Gets the int value.
 long getLong()
          Gets the long value.
 java.lang.Object getObject()
          Gets the Object value.
 short getShort()
          Gets the short value.
 java.lang.String getString()
          Gets the String value.
 java.lang.String[] getStringArr()
          Gets the String[] value.
 java.lang.String[] getValueAndKey()
          Gets the member name and its unique key combination.
 java.util.Vector getVector()
          Gets the Vector value.
 void setBoolean(boolean value)
          Sets the boolean value.
 void setDate(java.util.Date value)
          Sets the Date value.
 void setDouble(double value)
          Sets the double value.
 void setEssEnum(IEssEnum value)
          Sets the IEssEnum value.
 void setFloat(float value)
          Sets the float value.
 void setInt(int value)
          Sets the int value.
 void setLong(long value)
          Sets the long value.
 void setObject(java.lang.Object value)
          Sets the Object value.
 void setShort(short value)
          Sets the short value.
 void setString(java.lang.String value)
          Sets the String value.
 void setStringArr(java.lang.String[] value)
          Sets the String[] value.
 void setValueAndKey(java.lang.String memberName, java.lang.String key)
          Sets the member name and its unique key
 void setVector(java.util.Vector value)
          Sets the Vector value.

 

Method Detail

getDataType

IEssValueAny.EEssDataType getDataType()
                                      throws com.essbase.api.base.EssException
Gets the data type of the value.
Returns:
The data type of the value.
Throws:
EssException - if an error occurs.

getBoolean

boolean getBoolean()
                   throws com.essbase.api.base.EssException
Gets the boolean value.
Returns:
The boolean value.
Throws:
EssException - if an error occurs.

setBoolean

void setBoolean(boolean value)
                throws com.essbase.api.base.EssException
Sets the boolean value.
Parameters:
value - The boolean value.
Throws:
EssException - if an error occurs.

getString

java.lang.String getString()
                           throws com.essbase.api.base.EssException
Gets the String value.
Returns:
The String value.
Throws:
EssException - if an error occurs.

setString

void setString(java.lang.String value)
               throws com.essbase.api.base.EssException
Sets the String value.
Parameters:
value - The String value.
Throws:
EssException - if an error occurs.

getInt

int getInt()
           throws com.essbase.api.base.EssException
Gets the int value.
Returns:
The int value.
Throws:
EssException - if an error occurs.

setInt

void setInt(int value)
            throws com.essbase.api.base.EssException
Sets the int value.
Parameters:
value - The int value.
Throws:
EssException - if an error occurs.

getLong

long getLong()
             throws com.essbase.api.base.EssException
Gets the long value.
Returns:
The long value.
Throws:
EssException - if an error occurs.

setLong

void setLong(long value)
             throws com.essbase.api.base.EssException
Sets the long value.
Parameters:
value - The long value.
Throws:
EssException - if an error occurs.

getShort

short getShort()
               throws com.essbase.api.base.EssException
Gets the short value.
Returns:
The short value.
Throws:
EssException - if an error occurs.

setShort

void setShort(short value)
              throws com.essbase.api.base.EssException
Sets the short value.
Parameters:
value - The short value.
Throws:
EssException - if an error occurs.

getDouble

double getDouble()
                 throws com.essbase.api.base.EssException
Gets the double value.
Returns:
The double value.
Throws:
EssException - if an error occurs.

setDouble

void setDouble(double value)
               throws com.essbase.api.base.EssException
Sets the double value.
Parameters:
value - The double value.
Throws:
EssException - if an error occurs.

setValueAndKey

void setValueAndKey(java.lang.String memberName,
                    java.lang.String key)
                    throws com.essbase.api.base.EssException
Sets the member name and its unique key
Parameters:
memberName - the member name
key - the unique key
Throws:
EssException - if an error occurs.

getFloat

float getFloat()
               throws com.essbase.api.base.EssException
Gets the float value.
Returns:
The float value.
Throws:
EssException - if an error occurs.

setFloat

void setFloat(float value)
              throws com.essbase.api.base.EssException
Sets the float value.
Parameters:
value - The float value.
Throws:
EssException - if an error occurs.

getEssEnum

IEssEnum getEssEnum()
                    throws com.essbase.api.base.EssException
Gets the IEssEnum value.
Returns:
The IEssEnum value.
Throws:
EssException - if an error occurs.

getValueAndKey

java.lang.String[] getValueAndKey()
                                  throws com.essbase.api.base.EssException
Gets the member name and its unique key combination.
Returns:
String array with item at index 0 the member name and item at index 1 as key.
Throws:
EssException - if an error occurs.

setEssEnum

void setEssEnum(IEssEnum value)
                throws com.essbase.api.base.EssException
Sets the IEssEnum value.
Parameters:
value - The IEssEnum value.
Throws:
EssException - if an error occurs.

getObject

java.lang.Object getObject()
                           throws com.essbase.api.base.EssException
Gets the Object value.
Returns:
The Object value.
Throws:
EssException - if an error occurs.

setObject

void setObject(java.lang.Object value)
               throws com.essbase.api.base.EssException
Sets the Object value.
Parameters:
value - The Object value.
Throws:
EssException - if an error occurs.

getVector

java.util.Vector getVector()
                           throws com.essbase.api.base.EssException
Gets the Vector value.
Returns:
The Vector value.
Throws:
EssException - if an error occurs.

setVector

void setVector(java.util.Vector value)
               throws com.essbase.api.base.EssException
Sets the Vector value.
Parameters:
value - The Vector value.
Throws:
EssException - if an error occurs.

getDate

java.util.Date getDate()
                       throws com.essbase.api.base.EssException
Gets the Date value.
Returns:
The Date value.
Throws:
EssException - if an error occurs.

setDate

void setDate(java.util.Date value)
             throws com.essbase.api.base.EssException
Sets the Date value.
Parameters:
value - The Date value.
Throws:
EssException - if an error occurs.

getStringArr

java.lang.String[] getStringArr()
                                throws com.essbase.api.base.EssException
Gets the String[] value.
Returns:
The String[] value.
Throws:
EssException - if an error occurs.

setStringArr

void setStringArr(java.lang.String[] value)
                  throws com.essbase.api.base.EssException
Sets the String[] value.
Parameters:
value - The String[] value.
Throws:
EssException - if an error occurs.

Skip navigation links