|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IEssOpZoomIn interface.
Nested Class Summary | |
static class |
IEssOpZoomIn.EEssZoomInPreference
The EEssZoomInPreference class is an enumeration of zoom in preferences. |
Nested classes inherited from class com.essbase.api.dataquery.IEssOperation |
IEssOperation.EEssOperationType |
Method Summary | |
void |
addCell(int startRow,
int startColumn)
Adds a cell to operate on. |
void |
addRange(int startRow,
int startColumn,
int countRows,
int countColumns)
Adds range of cells to zoom-in. |
int |
getCountRanges()
Gets the count of cell ranges to zoom-in. |
IEssOpZoomIn.EEssZoomInPreference |
getPreference()
Gets the zoom in preference. |
IEssCubeView.EEssQueryGrammar |
getQueryGrammar()
Gets the grammar for the query/report specification. |
java.lang.String |
getQuerySpec()
Gets the query/report specification relating to the condition for retrieval. |
IEssIterator |
getRanges()
Gets the list of call ranges to zoom-in. |
boolean |
isConditionalZoomIn()
Checks if the operation is conditional zoom-in. |
boolean |
isNoAttributes()
Checks if to obtain attributes for the resulting cell values. |
boolean |
isZoomDown()
Checks if any page/title dimensions selected will be zoomed down. |
void |
setNoAttributes(boolean noAttributes)
Sets if to obtain attributes for the resulting cell values. |
void |
setPreference(boolean zoomDown,
IEssOpZoomIn.EEssZoomInPreference pref)
Sets the zoom-in preference. |
void |
setQuery(boolean zoomDown,
java.lang.String querySpec,
IEssCubeView.EEssQueryGrammar queryGrammar)
Sets the query/report specification relating to the conditional zoom-in. |
void |
setZoomDown(boolean zoomDown)
Sets if any page/title dimensions selected will be zoomed down. |
Methods inherited from interface com.essbase.api.dataquery.IEssOperation |
getOperationType |
Method Detail |
public void addCell(int startRow, int startColumn) throws EssException
startRow
- The start row.startColumn
- The start column.
EssException
- if an error occurs.public void addRange(int startRow, int startColumn, int countRows, int countColumns) throws EssException
startRow
- The start row.startColumn
- The start column.countRows
- The count of rows.countColumns
- The count of columns.
EssException
- if an error occurs.public int getCountRanges() throws EssException
EssException
- if an error occurs.public IEssIterator getRanges() throws EssException
EssException
- if an error occurspublic IEssOpZoomIn.EEssZoomInPreference getPreference() throws EssException
EssException
- if an error occurs.public void setPreference(boolean zoomDown, IEssOpZoomIn.EEssZoomInPreference pref) throws EssException
zoomDown
- true, if any page/title dimensions will be zoomed down.
false, if they will be zoomed across.pref
- The zoom-in preference.
EssException
- if an error occurs.public java.lang.String getQuerySpec() throws EssException
EssException
- if an error occurs.public IEssCubeView.EEssQueryGrammar getQueryGrammar() throws EssException
EssException
- if an error occurs.public void setQuery(boolean zoomDown, java.lang.String querySpec, IEssCubeView.EEssQueryGrammar queryGrammar) throws EssException
querySpec
- The query/report specification.
EssException
- if an error occurs.public boolean isZoomDown() throws EssException
EssException
- if an error occurs.public void setZoomDown(boolean zoomDown) throws EssException
zoomDown
- true if to zoom down. false if to zoom across.
EssException
- if an error occurs.public boolean isConditionalZoomIn() throws EssException
EssException
- if an error occurs.public boolean isNoAttributes() throws EssException
EssException
- if an error occurs.public void setNoAttributes(boolean noAttributes) throws EssException
noAttributes
- true, if to obtain attributes for the resulting cell
values.
EssException
- if an error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |