com.essbase.api.dataquery

Interface IEssDataCell

All Superinterfaces:

IEssBaseObject, IEssCell

public interface IEssDataCell
extends IEssCell

The IEssDataCell interface is a single cell of data.

Version:

1.0, 04/04/2001

Author:

Srini Ranga

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IEssDataCell.EEssAccessMode The EEssAccessMode is an enumeration of cell access modes.
static class	IEssDataCell.EEssDataCellType The EEssDataCellType class is an enumeration of cell value types.

Nested classes/interfaces inherited from interface com.essbase.api.dataquery.IEssCell

IEssCell.EEssCellType

Method Summary

Modifier and Type	Method and Description
IEssLinkedObject	createLinkedFileObject(java.lang.String desciption, java.lang.String fileNameTag, byte[] content) Creates a linked file object in the cell.
IEssLinkedObject	createLinkedObject(IEssLinkedObject.EEssLinkedObjectType type, java.lang.String desc, java.lang.String ref) Creates a linked object in the cell.
void	deleteLinkedObject(IEssLinkedObject obj) Deletes a linked object in the cell.
void	deleteLinkedObjects() Deletes all linked object in the cell.
IEssDataCell.EEssAccessMode	getAccessMode() Gets the access mode.
int	getColumnId() Gets the column id.
IEssDataCell.EEssDataCellType	getDataCellType() Gets the data cell type.
double	getDoubleValue() Gets the double value of the data cell.
IEssIterator	getLinkedObjects() Gets the linked objects in the cell.
java.lang.String[]	getMemberCombination() Gets the member combination for the cell.
int	getRowId() Gets the row id.
java.lang.String[]	getURLDrillThrough() Gets the drill through reports associated with a data cell as an array of String containing XML for the cells member combination.
boolean	isCellNoteLinked() Checks if the cell has linked cell note.
boolean	isDrillThrough()
boolean	isObjectsLinked() Checks if the cell has linked objects.
boolean	isPartitionLinked() Checks if the cell has linked partitions.
boolean	isURLDrillThrough() This Checks if the cell has a drill through URL.
boolean	isUrlLinked() Checks if the cell has linked URL.
boolean	isWinAppLinked() Checks if the cell has linked windows apps.
void	setValue(double value) Sets the data cell value.

Methods inherited from interface com.essbase.api.dataquery.IEssCell

getCellType, getValue, setValue

Method Detail

getRowId

int getRowId()
      throws com.essbase.api.base.EssException

Gets the row id.

Returns:

The row id.

Throws:

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

getColumnId

int getColumnId()
         throws com.essbase.api.base.EssException

Gets the column id.

Returns:

The column id.

Throws:

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

getDataCellType

IEssDataCell.EEssDataCellType getDataCellType()
                                       throws com.essbase.api.base.EssException

Gets the data cell type.

Returns:

The data cell type.

Throws:

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

getAccessMode

IEssDataCell.EEssAccessMode getAccessMode()
                                   throws com.essbase.api.base.EssException

Gets the access mode. This method checks the filter definition and also for the presence of dynamic calc member (or, label only member with the first child as dynamic calc).

Returns:

The access mode.

Throws:

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

isObjectsLinked

boolean isObjectsLinked()
                 throws com.essbase.api.base.EssException

Checks if the cell has linked objects.

Returns:

true, if the cell has linked objects.

Throws:

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

isPartitionLinked

boolean isPartitionLinked()
                   throws com.essbase.api.base.EssException

Checks if the cell has linked partitions.

Returns:

true, if the cell has linked partitions.

Throws:

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

isCellNoteLinked

boolean isCellNoteLinked()
                  throws com.essbase.api.base.EssException

Checks if the cell has linked cell note.

Returns:

true, if the cell has linked cell note.

Throws:

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

isWinAppLinked

boolean isWinAppLinked()
                throws com.essbase.api.base.EssException

Checks if the cell has linked windows apps.

Returns:

true, if the cell has linked windows apps.

Throws:

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

isUrlLinked

boolean isUrlLinked()
             throws com.essbase.api.base.EssException

Checks if the cell has linked URL.

Returns:

true, if the cell has linked URL.

Throws:

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

isDrillThrough

boolean isDrillThrough()
                throws com.essbase.api.base.EssException

Returns:

true, if the cell is drill through.

Throws:

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

getDoubleValue

double getDoubleValue()
               throws com.essbase.api.base.EssException

Gets the double value of the data cell.

Returns:

The double value.

Throws:

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

setValue

void setValue(double value)
       throws com.essbase.api.base.EssException

Sets the data cell value.

Parameters:

value - The double value.

Throws:

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

getMemberCombination

java.lang.String[] getMemberCombination()
                                 throws com.essbase.api.base.EssException

Gets the member combination for the cell.

Returns:

The member combination.

Throws:

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

createLinkedObject

IEssLinkedObject createLinkedObject(IEssLinkedObject.EEssLinkedObjectType type,
                                    java.lang.String desc,
                                    java.lang.String ref)
                             throws com.essbase.api.base.EssException

Creates a linked object in the cell.

Parameters:

type - The object type.

desc - The object description. For cell note type, specify the actual cell note here. For url/file type, specify the description here.

ref - The object reference. For cell note type, this param is ignored. For url type, specify the url here. For file type, specify the file name here.

Returns:

The linked object.

Throws:

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

createLinkedFileObject

IEssLinkedObject createLinkedFileObject(java.lang.String desciption,
                                        java.lang.String fileNameTag,
                                        byte[] content)
                                 throws com.essbase.api.base.EssException

Creates a linked file object in the cell.

Parameters:

desciption - The file description.

fileNameTag - The name used to identify the bytes.

content - The file content bytes.

Returns:

The linked object.

Throws:

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

getLinkedObjects

IEssIterator getLinkedObjects()
                       throws com.essbase.api.base.EssException

Gets the linked objects in the cell.

Returns:

The linked objects (each of type IEssLinkedObject).

Throws:

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

deleteLinkedObject

void deleteLinkedObject(IEssLinkedObject obj)
                 throws com.essbase.api.base.EssException

Deletes a linked object in the cell.

Parameters:

obj - The linked object.

Throws:

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

deleteLinkedObjects

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

Deletes all linked object in the cell.

Throws:

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

isURLDrillThrough

boolean isURLDrillThrough()
                   throws com.essbase.api.base.EssException

This Checks if the cell has a drill through URL.

Returns:

true if cell has aURL Drill Through associated with it.

Throws:

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

Since:

11.1.1.3

getURLDrillThrough

java.lang.String[] getURLDrillThrough()
                               throws com.essbase.api.base.EssException

Gets the drill through reports associated with a data cell as an array of String containing XML for the cells member combination.

Returns:

If successful, this API returns an array of Strings.

Throws:

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

Since:

11.1.1.3