com.essbase.api.dataquery

Interface IEssOpCalculate

All Superinterfaces:

IEssBaseObject, IEssOperation

public interface IEssOpCalculate
extends IEssOperation

The IEssOpCalculate 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
EssCalcStatus	getResult() API to get the calc result
java.lang.String[]	getRTSV() Gets all the Run Time Substitution Variables set for this calc operation
void	set(boolean syntaxCheckOnly, java.lang.String calcFileNamePrefix) Executes a calc script against the active database from a file.
void	set(java.lang.String calcScript, boolean syntaxCheckOnly) Sends and optionally executes a calc script against this active cube as a single string.
void	setRTSV(java.lang.String[] rtsv) For Calculate operations with Run Time Substitution Variables. Existing RTSV has to be fetched from server using API IEssCube.getCalcFileRunTimeSubVars(String). Loop through all the RTSV's and build string array of RTSV in the below mentioned format String RTSV = RTSV_KEY = RTSV_VALUE + [RTSV_LIMIT] + Semicolon[;] ; //Semicolon is mandatory String[] RTSVS = {RTSV0, RTSV1..};

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

getOperationType

Method Detail

set

void set(java.lang.String calcScript,
         boolean syntaxCheckOnly)
  throws com.essbase.api.base.EssException

Sends and optionally executes a calc script against this active cube as a single string. The calculation can either be performed, or the calc script can just be verified and any errors returned.

Parameters:

calcScript - The calc script as a single string. If null or "" is passed default calc script is used.

syntaxCheckOnly - true if to perform syntax check only.

Throws:

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

set

void set(boolean syntaxCheckOnly,
         java.lang.String calcFileNamePrefix)
  throws com.essbase.api.base.EssException

Executes a calc script against the active database from a file. The calculation can either be performed, or the calc script can just be verified and any errors returned.

Parameters:

syntaxCheckOnly - true if to perform syntax check only.

calcFileNamePrefix - The calc script file name's prefix. This file should be located in the olap server's application/cube directory, with extension '.csc'. For eq, if the file name is calcall.csc, you should pass "calcall" to this param.

Throws:

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

getRTSV

java.lang.String[] getRTSV()

Gets all the Run Time Substitution Variables set for this calc operation

Returns:

- Array of RTSV Key Value pairs

setRTSV

void setRTSV(java.lang.String[] rtsv)

For Calculate operations with Run Time Substitution Variables.
Existing RTSV has to be fetched from server using API IEssCube.getCalcFileRunTimeSubVars(String).
Loop through all the RTSV's and build string array of RTSV in the below mentioned format
String RTSV = RTSV_KEY = RTSV_VALUE + [RTSV_LIMIT] + Semicolon[;] ; //Semicolon is mandatory
String[] RTSVS = {RTSV0, RTSV1..};

Parameters:

rtsv - - String Array of Run Time Substitution Variables

getResult

EssCalcStatus getResult()

API to get the calc result

Returns:

EssCalcStatus - Holds results of calculation