com.businessobjects.rebean.wi
Interface VariableExpression

All Superinterfaces:
ReportExpression, TreeNode

public interface VariableExpression
extends ReportExpression

Warning: This interface is no longer functional from the SAP BusinessObjects 4.0 release onwards.

The VariableExpression interface represents a user-defined variable.


Method Summary
 ReportExpression getAssociatedDimension()
          Returns the associated dimension if it exists.
 FormulaExpression getFormula()
          Returns the formula this variable is based on.
 SortInfo getSortInfo()
          Returns the SortInfo instance defining the way in which this VariableExpression instance has been sorted.
 java.lang.String getSourceName()
          Returns the name of this variable in the locale it was created.
 boolean isStripped()
           
 void setAssociatedDimension(ReportExpression dimension)
          Changes the variable associate dimension for DETAIL qualified variable.
 void setName(java.lang.String name)
          Changes the name of this variable.
 void setQualification(ObjectQualification qualif)
          Changes the qualification of this variable.
 void setValue(java.lang.String value)
          Changes the definition of this variable.
 
Methods inherited from interface com.businessobjects.rebean.wi.ReportExpression
getDataSource, getDataSourceObject, getFormulaLanguageID, getID, getName, getQualification, getType
 
Methods inherited from interface com.businessobjects.rebean.wi.TreeNode
getChildAt, getChildCount, getIndex, getParent, isLeaf
 

Method Detail

getFormula

FormulaExpression getFormula()
Returns the formula this variable is based on.

Returns:
the formula

setName

void setName(java.lang.String name)
Changes the name of this variable. Note that no two variables are allowed to have the same name.

Parameters:
name - the new name
Throws:
ServerException - when the name is invalid
java.lang.NullPointerException - when name is null
Since:
6.5.0

getSourceName

java.lang.String getSourceName()
Returns the name of this variable in the locale it was created.

Returns:
the name of this variable in the locale it was created.
Since:
12.2

setQualification

void setQualification(ObjectQualification qualif)
Changes the qualification of this variable.

Note for aggregation typed variable as "=Sum([Revenue])", you can't change its qualification.

Parameters:
qualif - the new object qualification
Throws:
java.lang.NullPointerException - when qualif is null
ServerException - when trying to set a invalidqualif.
Since:
6.5.0

setValue

void setValue(java.lang.String value)
Changes the definition of this variable.

Parameters:
value - the new definition
Throws:
ServerException - when the value is invalid
java.lang.NullPointerException - when value is null
Since:
6.5.0

setAssociatedDimension

void setAssociatedDimension(ReportExpression dimension)
Changes the variable associate dimension for DETAIL qualified variable.

Parameters:
dimension - new dimension to be associated. Could be null when you want to remove the associated dimension.
Throws:
java.lang.IllegalArgumentException - when dimension isn't in ReportDictionary or when dimension isn't qualified as DIMENSION or when dimension is an FormulaExpression or when variable's qualification isn't a DETAIL
REException - when something else goes wrong
Since:
11.5
See Also:
ReportDictionary.createVariable(String name, ObjectQualification qualif, String definition, ReportExpression dimension)

getAssociatedDimension

ReportExpression getAssociatedDimension()
Returns the associated dimension if it exists.

Returns:
the associated dimension
Since:
11.5

getSortInfo

SortInfo getSortInfo()
Returns the SortInfo instance defining the way in which this VariableExpression instance has been sorted.

Returns:
Returns the SortInfo instance associated to this VariableExpression.
Since:
11.5

isStripped

boolean isStripped()
Returns:
boolean
Since:
12.2