com.essbase.api.datasource

Interface IEssSubstitutionVariables

All Superinterfaces:

IEssBaseObject

All Known Subinterfaces:

IEssCube, IEssOlapApplication, IEssOlapServer

public interface IEssSubstitutionVariables
extends IEssBaseObject

The IEssSubstitutionVariables interface.

Version:

1.0, 04/04/2001

Author:

Srini Ranga

Method Summary

Modifier and Type	Method and Description
void	createSubstitutionVariable(java.lang.String varName, java.lang.String varValue) Creates a new substitution variable or modifies an existing substitution variable (if the variable name already exists) in this application.
void	deleteSubstitutionVariable(java.lang.String varName) Delete an existing substitution variable in this application.
java.lang.String[][]	getSubstitutionVariables() Gets the substitution variables in this application.
java.lang.String	getSubstitutionVariableValue(java.lang.String varName) Gets the value of a substitution variablein this application.

Method Detail

createSubstitutionVariable

void createSubstitutionVariable(java.lang.String varName,
                                java.lang.String varValue)
                         throws com.essbase.api.base.EssException

Creates a new substitution variable or modifies an existing substitution variable (if the variable name already exists) in this application.

Parameters:

varName - The variable name.

varValue - The variable value.

Throws:

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

deleteSubstitutionVariable

void deleteSubstitutionVariable(java.lang.String varName)
                         throws com.essbase.api.base.EssException

Delete an existing substitution variable in this application.

Parameters:

varName - The variable name.

Throws:

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

getSubstitutionVariableValue

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

Gets the value of a substitution variablein this application.

Parameters:

varName - The variable name.

Returns:

The variable value.

Throws:

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

getSubstitutionVariables

java.lang.String[][] getSubstitutionVariables()
                                       throws com.essbase.api.base.EssException

Gets the substitution variables in this application.

Returns:

The substitution variables. Each row contains name, value, application name, cube name, essbase server name (for e.g: [0][0] - variable name, [0][1] - value, [0][2] - application name, [0][3] - cube name, [0][4] - essbase server name).

Throws:

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