com.essbase.api.dataquery

Interface IEssDrillThroughReport

All Superinterfaces:

IEssBaseObject

public interface IEssDrillThroughReport
extends IEssBaseObject

The IEssDrillThroughReport is Integration Server drill-through report.

Version:

1.0, 04/04/2002

Author:

Srini Ranga

Method Summary

Modifier and Type	Method and Description
void	execute() Executes the report.
IEssValueAny.EEssDataType	getColumnDataType(int colId) Gets the column data type at the specified index.
java.lang.String	getColumnName(int colId) Gets the column name at the specified index.
int	getCountColumns() Gets the count of columns in the result set.
int	getCountRows() Gets the count of rows in the result set.
int	getCustomize() Gets the customize.
double	getDoubleValue(int rowId, int colId) Gets the double value at the specified row, column intersection.
float	getFloatValue(int rowId, int colId) Gets the float value at the specified row, column intersection.
int	getId() Gets the report id.
int	getIntValue(int rowId, int colId) Gets the int value at the specified row, column intersection.
java.lang.String	getName() Gets the report name.
int	getRowGoverner() Gets the row governer.
java.lang.String	getStringValue(int rowId, int colId) Gets the String value at the specified row, column intersection.
int	getTimeGoverner() Gets the time governer.
java.lang.String	getURL() Gets the URL if the report is a link to a URL.
IEssValueAny	getValue(int rowId, int colId) Gets the value at the specified row, column intersection.
java.lang.String	getViewName(int colId) Gets the view name at the specified index.

Method Detail

getId

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

Gets the report id.

Returns:

The report id.

Throws:

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

getName

java.lang.String getName()
                  throws com.essbase.api.base.EssException

Gets the report name.

Returns:

The report name.

Throws:

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

getCustomize

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

Gets the customize.

Returns:

0 if the report cannot be customized. non zero if the report can be customized.

Throws:

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

getRowGoverner

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

Gets the row governer.

Returns:

The row governer.

Throws:

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

getTimeGoverner

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

Gets the time governer.

Returns:

The time governer.

Throws:

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

execute

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

Executes the report.

Throws:

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

getCountColumns

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

Gets the count of columns in the result set.

Returns:

The count of columns in the result set.

Throws:

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

getColumnName

java.lang.String getColumnName(int colId)
                        throws com.essbase.api.base.EssException

Gets the column name at the specified index.

Parameters:

colId - The column id (0 to getCountColumns()-1).

Returns:

The column name.

Throws:

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

getViewName

java.lang.String getViewName(int colId)
                      throws com.essbase.api.base.EssException

Gets the view name at the specified index.

Parameters:

colId - The column id (0 to getCountColumns()-1).

Returns:

The view name. In case of BPM Drill Through, an empty String is returned.

Throws:

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

getColumnDataType

IEssValueAny.EEssDataType getColumnDataType(int colId)
                                     throws com.essbase.api.base.EssException

Gets the column data type at the specified index.

Parameters:

colId - The column id (0 to getCountColumns()-1).

Returns:

The column data type. One of EEssDataType.INT, STRING, FLOAT, DATE. NOTE: You need to use getStringValue() for DATE type.

Throws:

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

getCountRows

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

Gets the count of rows in the result set.

Returns:

The count of rows in the result set.

Throws:

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

getIntValue

int getIntValue(int rowId,
                int colId)
         throws com.essbase.api.base.EssException

Gets the int value at the specified row, column intersection.

Parameters:

rowId - The row id (0 to getCountRows()-1).

colId - The column id (0 to getCountColumns()-1).

Returns:

The int value.

Throws:

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

getStringValue

java.lang.String getStringValue(int rowId,
                                int colId)
                         throws com.essbase.api.base.EssException

Gets the String value at the specified row, column intersection.

Parameters:

rowId - The row id (0 to getCountRows()-1).

colId - The column id (0 to getCountColumns()-1).

Returns:

The string value.

Throws:

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

getFloatValue

float getFloatValue(int rowId,
                    int colId)
             throws com.essbase.api.base.EssException

Gets the float value at the specified row, column intersection.

Parameters:

rowId - The row id (0 to getCountRows()-1).

colId - The column id (0 to getCountColumns()-1).

Returns:

The float value.

Throws:

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

getDoubleValue

double getDoubleValue(int rowId,
                      int colId)
               throws com.essbase.api.base.EssException

Gets the double value at the specified row, column intersection.

Parameters:

rowId - The row id (0 to getCountRows()-1).

colId - The column id (0 to getCountColumns()-1).

Returns:

The double value.

Throws:

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

getValue

IEssValueAny getValue(int rowId,
                      int colId)
               throws com.essbase.api.base.EssException

Gets the value at the specified row, column intersection.

Parameters:

rowId - The row id (0 to getCountRows()-1).

colId - The column id (0 to getCountColumns()-1).

Returns:

The value.

Throws:

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

getURL

java.lang.String getURL()
                 throws com.essbase.api.base.EssException

Gets the URL if the report is a link to a URL.

Returns:

the URL String

Throws:

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