|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface VariableExpression
Warning: This interface is no longer functional from the SAP BusinessObjects 4.0 release onwards.
TheVariableExpression
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 |
---|
FormulaExpression getFormula()
void setName(java.lang.String name)
name
- the new name
ServerException
- when the name is invalid
java.lang.NullPointerException
- when name
is null
java.lang.String getSourceName()
void setQualification(ObjectQualification qualif)
Note for aggregation typed variable as "=Sum([Revenue])", you can't change its qualification.
qualif
- the new object qualification
java.lang.NullPointerException
- when qualif
is
null
ServerException
- when trying to set a invalidqualif
.void setValue(java.lang.String value)
value
- the new definition
ServerException
- when the value is invalid
java.lang.NullPointerException
- when value
is null
void setAssociatedDimension(ReportExpression dimension)
DETAIL
qualified variable.
dimension
- new dimension to be associated.
Could be null
when you want to remove the associated dimension.
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 wrongReportDictionary.createVariable(String name,
ObjectQualification qualif, String definition,
ReportExpression dimension)
ReportExpression getAssociatedDimension()
SortInfo getSortInfo()
SortInfo
instance defining the way in
which this VariableExpression
instance has been sorted.
SortInfo
instance associated to this
VariableExpression
.boolean isStripped()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |