com.essbase.api.dataquery

Interface IEssOpZoomOut

All Superinterfaces:

IEssBaseObject, IEssOperation

public interface IEssOpZoomOut
extends IEssOperation

The IEssOpZoomOut interface.

Version:

1.0, 04/04/2001

Author:

Srini Ranga

Nested Class Summary

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

IEssOperation.EEssOperationType

Method Summary

Modifier and Type	Method and Description
void	addCell(int startRow, int startColumn) Adds a cell to operate on.
void	addRange(int startRow, int startColumn, int countRows, int countColumns) Adds a range to operate on.
int	getCountRanges() Gets the count of ranges to operate on.
IEssIterator	getRanges() Gets the list of ranges to operate on.

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

getOperationType

Method Detail

addCell

void addCell(int startRow,
             int startColumn)
      throws com.essbase.api.base.EssException

Adds a cell to operate on. This method in turn calls addRange by passing 1 to both countRows and countColumns.

Parameters:

startRow - The start row.

startColumn - The start column.

Throws:

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

addRange

void addRange(int startRow,
              int startColumn,
              int countRows,
              int countColumns)
       throws com.essbase.api.base.EssException

Adds a range to operate on.

Parameters:

startRow - The start row.

startColumn - The start column.

countRows - The count of rows.

countColumns - The count of columns.

Throws:

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

getCountRanges

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

Gets the count of ranges to operate on.

Returns:

The count of ranges.

Throws:

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

getRanges

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

Gets the list of ranges to operate on.

Returns:

The list of ranges (each of type IEssGridRange).

Throws:

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