Skip navigation links

com.essbase.api.dataquery
Class IEssLinkedObject.EEssLinkedObjectType

java.lang.Object
com.essbase.api.dataquery.IEssLinkedObject.EEssLinkedObjectType

All Implemented Interfaces:

IEssBaseObject, IEssEnum

Enclosing interface:

IEssLinkedObject

public static final class IEssLinkedObject.EEssLinkedObjectType

extends java.lang.Object

implements IEssEnum

The EEssLinkedObjectType is an enumeration of linked object types.

Version:

1.0, 04/04/2002

Author:

Srini Ranga

Field Summary

static IEssLinkedObject.EEssLinkedObjectType	BPM_DRILL_THROUGH Linked object type: BPM Drill-through.
static int	BPM_DRILL_THROUGH_INT_VALUE Linked object type (int value): BPM Drill-through.
static IEssLinkedObject.EEssLinkedObjectType	CELL_NOTE Linked object type: Cell note.
static int	CELL_NOTE_INT_VALUE Linked object type (int value): Cell note.
static IEssLinkedObject.EEssLinkedObjectType	FILE Linked object type: File.
static int	FILE_INT_VALUE Linked object type (int value): File.
static IEssLinkedObject.EEssLinkedObjectType	HIS_DRILL_THROUGH Linked object type: HIS Drill-through.
static int	HIS_DRILL_THROUGH_INT_VALUE Linked object type (int value): HIS Drill-through.
static IEssLinkedObject.EEssLinkedObjectType	PARTITION Linked object type: Partition.
static int	PARTITION_INT_VALUE Linked object type (int value): Partition.
static IEssLinkedObject.EEssLinkedObjectType	URL Linked object type: URL.
static int	URL_INT_VALUE Linked object type (int value): URL.

Constructor Summary

IEssLinkedObject.EEssLinkedObjectType()

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

PARTITION

public static final IEssLinkedObject.EEssLinkedObjectType PARTITION

Linked object type: Partition.

CELL_NOTE

public static final IEssLinkedObject.EEssLinkedObjectType CELL_NOTE

Linked object type: Cell note.

FILE

public static final IEssLinkedObject.EEssLinkedObjectType FILE

Linked object type: File.

URL

public static final IEssLinkedObject.EEssLinkedObjectType URL

Linked object type: URL.

HIS_DRILL_THROUGH

public static final IEssLinkedObject.EEssLinkedObjectType HIS_DRILL_THROUGH

Linked object type: HIS Drill-through.

BPM_DRILL_THROUGH

public static final IEssLinkedObject.EEssLinkedObjectType BPM_DRILL_THROUGH

Linked object type: BPM Drill-through.

PARTITION_INT_VALUE

public static final int PARTITION_INT_VALUE

Linked object type (int value): Partition.

See Also:

Constant Field Values

CELL_NOTE_INT_VALUE

public static final int CELL_NOTE_INT_VALUE

Linked object type (int value): Cell note.

See Also:

Constant Field Values

FILE_INT_VALUE

public static final int FILE_INT_VALUE

Linked object type (int value): File.

See Also:

Constant Field Values

URL_INT_VALUE

public static final int URL_INT_VALUE

Linked object type (int value): URL.

See Also:

Constant Field Values

HIS_DRILL_THROUGH_INT_VALUE

public static final int HIS_DRILL_THROUGH_INT_VALUE

Linked object type (int value): HIS Drill-through.

See Also:

Constant Field Values

BPM_DRILL_THROUGH_INT_VALUE

public static final int BPM_DRILL_THROUGH_INT_VALUE

Linked object type (int value): BPM Drill-through.

See Also:

Constant Field Values

Constructor Detail

IEssLinkedObject.EEssLinkedObjectType

public IEssLinkedObject.EEssLinkedObjectType()

Method Detail

sm_fromString

public static IEssLinkedObject.EEssLinkedObjectType 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 IEssLinkedObject.EEssLinkedObjectType 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 IEssLinkedObject.EEssLinkedObjectType[] 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