Skip navigation links


com.essbase.api.datasource
Class IEssCube.EEssTimePeriod

java.lang.Object
  extended by com.essbase.api.datasource.IEssCube.EEssTimePeriod

All Implemented Interfaces:
IEssBaseObject, IEssEnum
Enclosing interface:
IEssCube

public static final class IEssCube.EEssTimePeriod
extends java.lang.Object
implements IEssEnum

EEssTimePeriod class represents a time period. This is valid only for Time Dimension members.

Version:
1.0, 02/28/2007
Author:
Balaji S

Field Summary
static IEssCube.EEssTimePeriod DAY
           
static int DAY_INT_VALUE
           
static IEssCube.EEssTimePeriod MONTH
           
static int MONTH_INT_VALUE
           
static IEssCube.EEssTimePeriod PERIOD
           
static int PERIOD_INT_VALUE
           
static IEssCube.EEssTimePeriod QUARTER
           
static int QUARTER_INT_VALUE
           
static IEssCube.EEssTimePeriod ROOT
           
static int ROOT_INT_VALUE
           
static IEssCube.EEssTimePeriod SEMESTER
           
static int SEMESTER_INT_VALUE
           
static IEssCube.EEssTimePeriod TRIMESTER
           
static int TRIMESTER_INT_VALUE
           
static IEssCube.EEssTimePeriod WEEK
           
static int WEEK_INT_VALUE
           
static IEssCube.EEssTimePeriod YEAR
           
static int YEAR_INT_VALUE
           

 

Constructor Summary
IEssCube.EEssTimePeriod()
           

 

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 IEssCube.EEssTimePeriod sm_fromInt(int intValue)
          Gets an enumeration object from its int value.
static IEssCube.EEssTimePeriod sm_fromString(java.lang.String strValue)
          Gets an enumeration object from its string display value.
static IEssCube.EEssTimePeriod[] 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

ROOT

public static final IEssCube.EEssTimePeriod ROOT

YEAR

public static final IEssCube.EEssTimePeriod YEAR

SEMESTER

public static final IEssCube.EEssTimePeriod SEMESTER

TRIMESTER

public static final IEssCube.EEssTimePeriod TRIMESTER

QUARTER

public static final IEssCube.EEssTimePeriod QUARTER

MONTH

public static final IEssCube.EEssTimePeriod MONTH

PERIOD

public static final IEssCube.EEssTimePeriod PERIOD

WEEK

public static final IEssCube.EEssTimePeriod WEEK

DAY

public static final IEssCube.EEssTimePeriod DAY

ROOT_INT_VALUE

public static final int ROOT_INT_VALUE
See Also:
Constant Field Values

YEAR_INT_VALUE

public static final int YEAR_INT_VALUE
See Also:
Constant Field Values

SEMESTER_INT_VALUE

public static final int SEMESTER_INT_VALUE
See Also:
Constant Field Values

TRIMESTER_INT_VALUE

public static final int TRIMESTER_INT_VALUE
See Also:
Constant Field Values

QUARTER_INT_VALUE

public static final int QUARTER_INT_VALUE
See Also:
Constant Field Values

MONTH_INT_VALUE

public static final int MONTH_INT_VALUE
See Also:
Constant Field Values

PERIOD_INT_VALUE

public static final int PERIOD_INT_VALUE
See Also:
Constant Field Values

WEEK_INT_VALUE

public static final int WEEK_INT_VALUE
See Also:
Constant Field Values

DAY_INT_VALUE

public static final int DAY_INT_VALUE
See Also:
Constant Field Values

Constructor Detail

IEssCube.EEssTimePeriod

public IEssCube.EEssTimePeriod()

Method Detail

sm_fromString

public static IEssCube.EEssTimePeriod 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:
com.essbase.api.base.EssException - if an error occurs.

sm_fromInt

public static IEssCube.EEssTimePeriod 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:
com.essbase.api.base.EssException - if an error occurs.

sm_values

public static IEssCube.EEssTimePeriod[] sm_values()
                                           throws com.essbase.api.base.EssException
Gets all the enumeration objects.
Returns:
The enumeration objects.
Throws:
com.essbase.api.base.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