com.essbase.api.dataquery

Interface IEssOpRetrieve

All Superinterfaces:

IEssBaseObject, IEssOperation

public interface IEssOpRetrieve
extends IEssOperation

The IEssOpRetrieve interface is a retrieve or conditional retrieve operation.

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
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.
boolean	isConditionalRetrieve() Checks if the operation is conditional retrieve.
boolean	isLockDataBlocks() Checks if to lock data blocks on retrieval.
boolean	isNoAttributes() Checks if to obtain attributes for the resulting cell values.
void	setLockDataBlocks(boolean lockDataBlocks) Sets if to lock data blocks on retrieval.
void	setNoAttributes(boolean noAttributes) Sets if not to obtain attributes for the resulting cell values.
void	setQuery(java.lang.String querySpec, IEssCubeView.EEssQueryGrammar queryGrammar) Sets the query/report specification relating to the condition for retrieval.

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

getOperationType

Method Detail

isLockDataBlocks

boolean isLockDataBlocks()
                  throws com.essbase.api.base.EssException

Checks if to lock data blocks on retrieval.

Returns:

true, if to lock associated data blocks.

Throws:

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

setLockDataBlocks

void setLockDataBlocks(boolean lockDataBlocks)
                throws com.essbase.api.base.EssException

Sets if to lock data blocks on retrieval.

Parameters:

lockDataBlocks - - true, if to lock associated data blocks.

Throws:

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

getQuerySpec

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

Gets the query/report specification relating to the condition for retrieval.

Returns:

The report specification.

Throws:

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

getQueryGrammar

IEssCubeView.EEssQueryGrammar getQueryGrammar()
                                       throws com.essbase.api.base.EssException

Gets the grammar for the query/report specification.

Returns:

The query grammar.

Throws:

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

setQuery

void setQuery(java.lang.String querySpec,
              IEssCubeView.EEssQueryGrammar queryGrammar)
       throws com.essbase.api.base.EssException

Sets the query/report specification relating to the condition for retrieval.

Parameters:

querySpec - The query/report specification.

queryGrammar - The query/report specification grammar type.

Throws:

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

isConditionalRetrieve

boolean isConditionalRetrieve()
                       throws com.essbase.api.base.EssException

Checks if the operation is conditional retrieve.

Returns:

true, if the operation is conditional retrieve.

Throws:

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

isNoAttributes

boolean isNoAttributes()
                throws com.essbase.api.base.EssException

Checks if to obtain attributes for the resulting cell values. This is effective only when used as a ConditionalRetrive operation.

Returns:

true, if not to obtain attributes for the resulting cell values.

Throws:

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

setNoAttributes

void setNoAttributes(boolean noAttributes)
              throws com.essbase.api.base.EssException

Sets if not to obtain attributes for the resulting cell values. Default behavior is to obtain attributes for the resulting cell values. This is effective only when used as a ConditionalRetrive operation.

Parameters:

noAttributes - true, if not to obtain attributes for the resulting cell values.

Throws:

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