|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEssOpZoomIn
The IEssOpZoomIn interface.
Nested Class Summary | |
---|---|
static class |
IEssOpZoomIn.EEssZoomInPreference The EEssZoomInPreference class is an enumeration of zoom in preferences. |
Nested classes/interfaces inherited from interface 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 cell 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 |
---|
void addCell(int startRow, int startColumn) throws com.essbase.api.base.EssException
startRow
- The start row.startColumn
- The start column.com.essbase.api.base.EssException
- if an error occurs.void addRange(int startRow, int startColumn, int countRows, int countColumns) throws com.essbase.api.base.EssException
startRow
- The start row.startColumn
- The start column.countRows
- The count of rows.countColumns
- The count of columns.com.essbase.api.base.EssException
- if an error occurs.int getCountRanges() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.IEssIterator getRanges() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occursIEssOpZoomIn.EEssZoomInPreference getPreference() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setPreference(boolean zoomDown, IEssOpZoomIn.EEssZoomInPreference pref) throws com.essbase.api.base.EssException
zoomDown
- true, if any page/title dimensions will be zoomed down. false, if they will be zoomed across.pref
- The zoom-in preference.com.essbase.api.base.EssException
- if an error occurs.java.lang.String getQuerySpec() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.IEssCubeView.EEssQueryGrammar getQueryGrammar() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setQuery(boolean zoomDown, java.lang.String querySpec, IEssCubeView.EEssQueryGrammar queryGrammar) throws com.essbase.api.base.EssException
querySpec
- The query/report specification.queryGrammar
- The query/report specification grammar type.com.essbase.api.base.EssException
- if an error occurs.boolean isZoomDown() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setZoomDown(boolean zoomDown) throws com.essbase.api.base.EssException
zoomDown
- true if to zoom down. false if to zoom across.com.essbase.api.base.EssException
- if an error occurs.boolean isConditionalZoomIn() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.boolean isNoAttributes() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setNoAttributes(boolean noAttributes) throws com.essbase.api.base.EssException
noAttributes
- true, if to obtain attributes for the resulting cell values.com.essbase.api.base.EssException
- if an error occurs.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |