Skip navigation links


com.essbase.api.base
Class IEssProperties.EEssPropertyMode

java.lang.Object
  extended by com.essbase.api.base.IEssProperties.EEssPropertyMode

All Implemented Interfaces:
IEssBaseObject, IEssEnum, java.io.Serializable
Enclosing interface:
IEssProperties

public static final class IEssProperties.EEssPropertyMode
extends java.lang.Object
implements IEssEnum, java.io.Serializable

The EEssPropertyMode is an enumeration of property modes.

Version:
1.0, 04/04/2001
Author:
Srini Ranga
See Also:
Serialized Form

Field Summary
static IEssProperties.EEssPropertyMode NO_ACCESS
          Property mode: No access.
static int NO_ACCESS_INT_VALUE
          Property mode (int value): No access.
static IEssProperties.EEssPropertyMode READ_ONLY
          Property mode: Read only.
static int READ_ONLY_INT_VALUE
          Property mode (int value): Read only.
static IEssProperties.EEssPropertyMode READ_WRITE
          Property mode: Read and write.
static int READ_WRITE_INT_VALUE
          Property mode (int value): Read and write.
static IEssProperties.EEssPropertyMode WRITE_ONLY
          Property mode: Write only.
static int WRITE_ONLY_INT_VALUE
          Property mode (int value): Write only.

 

Constructor Summary
IEssProperties.EEssPropertyMode()
           

 

Method Summary
 IEssEnum fromInt(int intValue)
          Gets the IEssEnum from the int value.
 IEssEnum fromString(java.lang.String strValue)
          Gets the IEssEnum from the String display value.
 int getCountPossibleValues()
          Gets the count of possible values of the enumeration.
 java.lang.String[] getPossibleValues()
          Gets the list of possible values of the enumeration.
 int intValue()
          Gets the int value of the IEssEnum.
static IEssProperties.EEssPropertyMode sm_fromInt(int intValue)
          Gets an enumeration object from its int value.
static IEssProperties.EEssPropertyMode sm_fromString(java.lang.String strValue)
          Gets an enumeration object from its string display value.
static IEssProperties.EEssPropertyMode[] sm_values()
          Gets all the enumeration objects.
 java.lang.String stringValue()
          Gets the String display value of the IEssEnum.
 java.lang.String toString()
           

 

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

 

Field Detail

NO_ACCESS

public static final IEssProperties.EEssPropertyMode NO_ACCESS
Property mode: No access.

READ_ONLY

public static final IEssProperties.EEssPropertyMode READ_ONLY
Property mode: Read only.

READ_WRITE

public static final IEssProperties.EEssPropertyMode READ_WRITE
Property mode: Read and write.

WRITE_ONLY

public static final IEssProperties.EEssPropertyMode WRITE_ONLY
Property mode: Write only.

NO_ACCESS_INT_VALUE

public static final int NO_ACCESS_INT_VALUE
Property mode (int value): No access.
See Also:
Constant Field Values

READ_ONLY_INT_VALUE

public static final int READ_ONLY_INT_VALUE
Property mode (int value): Read only.
See Also:
Constant Field Values

READ_WRITE_INT_VALUE

public static final int READ_WRITE_INT_VALUE
Property mode (int value): Read and write.
See Also:
Constant Field Values

WRITE_ONLY_INT_VALUE

public static final int WRITE_ONLY_INT_VALUE
Property mode (int value): Write only.
See Also:
Constant Field Values

Constructor Detail

IEssProperties.EEssPropertyMode

public IEssProperties.EEssPropertyMode()

Method Detail

sm_fromString

public static IEssProperties.EEssPropertyMode sm_fromString(java.lang.String strValue)
                                                     throws com.essbase.api.base.EssException
Gets an enumeration object from its string display value.
Parameters:
strValue - The string display value.
Returns:
The enumeration object.
Throws:
EssException - if an error occurs.

sm_fromInt

public static IEssProperties.EEssPropertyMode sm_fromInt(int intValue)
                                                  throws com.essbase.api.base.EssException
Gets an enumeration object from its int value.
Parameters:
intValue - The int value.
Returns:
The enumeration object.
Throws:
EssException - if an error occurs.

sm_values

public static IEssProperties.EEssPropertyMode[] sm_values()
                                                   throws com.essbase.api.base.EssException
Gets all the enumeration objects.
Returns:
The enumeration objects.
Throws:
EssException - if an error occurs.

stringValue

public java.lang.String stringValue()
                             throws com.essbase.api.base.EssException
Description copied from interface: IEssEnum
Gets the String display value of the IEssEnum.
Specified by:
stringValue in interface IEssEnum
Returns:
The String display value of the IEssEnum.
Throws:
EssException - if an error occurs.

intValue

public int intValue()
             throws com.essbase.api.base.EssException
Description copied from interface: IEssEnum
Gets the int value of the IEssEnum.
Specified by:
intValue in interface IEssEnum
Returns:
The int value of the IEssEnum.
Throws:
EssException - if an error occurs.

fromInt

public IEssEnum fromInt(int intValue)
                 throws com.essbase.api.base.EssException
Description copied from interface: IEssEnum
Gets the IEssEnum from the int value.
Specified by:
fromInt in interface IEssEnum
Parameters:
intValue - The int value.
Returns:
The IEssEnum interface.
Throws:
EssException - if an error occurs.

fromString

public IEssEnum fromString(java.lang.String strValue)
                    throws com.essbase.api.base.EssException
Description copied from interface: IEssEnum
Gets the IEssEnum from the String display value.
Specified by:
fromString in interface IEssEnum
Parameters:
strValue - The String display value.
Returns:
The IEssEnum interface.
Throws:
EssException - if an error occurs.

getCountPossibleValues

public int getCountPossibleValues()
                           throws com.essbase.api.base.EssException
Description copied from interface: IEssEnum
Gets the count of possible values of the enumeration.
Specified by:
getCountPossibleValues in interface IEssEnum
Returns:
The count of possible values in the enumeration.
Throws:
EssException - if an error occurs.

getPossibleValues

public java.lang.String[] getPossibleValues()
                                     throws com.essbase.api.base.EssException
Description copied from interface: IEssEnum
Gets the list of possible values of the enumeration.
Specified by:
getPossibleValues in interface IEssEnum
Returns:
The list of possible values in the enumeration.
Throws:
EssException - if an error occurs.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

Skip navigation links