com.essbase.api.dataquery

Interface IEssOpCascade

All Superinterfaces:

IEssBaseObject, IEssOperation

public interface IEssOpCascade
extends IEssOperation

The IEssOpCascade interface.

Version:

1.0, 04/24/2003

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	addRange(int startRow, int startColumn, int countRows, int countColumns, IEssOpZoomIn.EEssZoomInPreference pref) Adds range of cells to cascade.
int	getCountRanges() Gets the count of cell ranges to cascade.
IEssIterator	getRanges() Gets the list of cell ranges to cascade.
void	set(boolean supMissing, boolean listFile, short level, java.lang.String prefix, java.lang.String suffix, java.lang.String header, java.lang.String footer, java.lang.String path) Sets cascading options.

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

getOperationType

Method Detail

addRange

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

Adds range of cells to cascade.

Parameters:

startRow - The start row.

startColumn - The start column.

countRows - The count of rows.

countColumns - The count of columns.

pref - The zoom in preference.

Throws:

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

getCountRanges

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

Gets the count of cell ranges to cascade.

Returns:

The count of cell ranges to cascade.

Throws:

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

getRanges

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

Gets the list of cell ranges to cascade.

Returns:

The list of cell ranges to cascade.

Throws:

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

set

void set(boolean supMissing,
         boolean listFile,
         short level,
         java.lang.String prefix,
         java.lang.String suffix,
         java.lang.String header,
         java.lang.String footer,
         java.lang.String path)
  throws com.essbase.api.base.EssException

Sets cascading options.

Parameters:

supMissing - true is sup is missing.

listFile - true if listing of files required.

level - The number of level.

prefix - The prefix string.

suffix - The suffix string.

header - The header string.

footer - The footer string.

path - The path string.

Throws:

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