|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AdvancedCondition
Warning: This interface is no longer functional from the SAP BusinessObjects 4.0 release onwards.
The AdvancedCondition
interface represents a sub query.
An AdvancedCondition
is defined by:
DataSourceObject
.ConditionOperator
ComparisonOperator
, ConditionOperator
is
one of the following: IN_LIST
or NOT_IN_LIST
,
ComparisonOperator
should be null
.
If the ConditionOperator
is EQUAL
ComparisonOperator
should be ComparisonOperator.ANY
.
For other values of ConditionOperator
,
ComparisonOperator
can be ComparisonOperator.ANY
or
ComparisonOperator.ALL
.
DataSourceObject
.The following code shows how to create an AdvancedCondition
.
ConditionContainer condCont = null;
condCont = query.createCondition(LogicalOperator.AND);
AdvancedCondition aCond = condCont.createAdvancedCondition(
new DataSourceObject[] { query.getResultObject(0)},ConditionOperator.IN_LIST,null,
new DataSourceObject[] { query.getResultObject(1)});
myDataProvider.runQuery();
This class can have only one child node
,
for more information see AdvancedCondition.createCondition(LogicalOperator)
.
ConditionContainer.createAdvancedCondition(DataSourceObject[], ConditionOperator, ComparisonOperator, DataSourceObject[])
Method Summary | |
---|---|
void |
addFilterObject(DataSourceObject dso)
Add a DataSourceObject to filter
this AdvancedCondition . |
void |
addResultObject(DataSourceObject dso)
Add a result object to this AdvancedCondition . |
ConditionContainer |
copyCondition(ConditionContainer cont)
Makes a copy of cont and adds it to this advanced condition. |
ConditionContainer |
createCondition(LogicalOperator op)
Creates a ConditionContainer for this advanced condition. |
ComparisonOperator |
getComparisonOperator()
Returns the ComparisonOperator from the AdvancedCondition
tree. |
ConditionContainer |
getCondition()
Returns the ConditionContainer set in this
AdvancedCondition . |
ConditionOperator |
getConditionOperator()
Returns the ConditionOperator defined in this
AdvancedCondition object. |
DataSourceObject |
getDimension(int index)
Deprecated. Use AdvancedCondition.getFilterObject(int) instead. |
int |
getDimensionCount()
Deprecated. Use AdvancedCondition.getFilterObjectCount() instead. |
DataSourceObject |
getFilterObject(int index)
Returns the DataSourceObject at index used to filter
this AdvancedCondition . |
int |
getFilterObjectCount()
Returns the number of DataSourceObject instances used
as filter objects on this AdvancedCondition . |
DataSourceObject |
getResultObject(int index)
Returns the DataSourceObject at the specific index in the result part of
the AdvancedCondition tree. |
int |
getResultObjectCount()
Returns the number of DataSourceObject instances in the result part of
the AdvancedCondition . |
boolean |
hasCondition()
Returns true when at least one ConditionContainer
has been added to this AdvancedCondition object. |
void |
removeCondition()
Deletes the condition part of this AdvancedCondition . |
void |
removeFilterObject(int index)
Remove a filter object from a specific index in this AdvancedCondition object. |
void |
removeResultObject(int index)
Remove a result object from this AdvancedCondition . |
void |
setComparisonOperator(ComparisonOperator operator)
Set a ComparisonOperator such as ANY or ALL
in the AdvancedCondition tree. |
void |
setConditionOperator(ConditionOperator operator)
Set a ConditionOperator such as EQUAL or
NOT_EQUAL in the AdvancedCondition tree. |
Methods inherited from interface com.businessobjects.rebean.wi.FilterConditionNode |
---|
getFilterConditionNode, getID, getName, remove, removeAllChildren |
Methods inherited from interface com.businessobjects.rebean.wi.TreeNode |
---|
getChildAt, getChildCount, getIndex, getParent, isLeaf |
Method Detail |
---|
@Deprecated int getDimensionCount()
AdvancedCondition.getFilterObjectCount()
instead.
AdvancedCondition
uses.
AdvancedCondition
uses.@Deprecated DataSourceObject getDimension(int index)
AdvancedCondition.getFilterObject(int)
instead.
DataSourceObject
containing a dimension
stored at a specific index in the AdvancedCondition
.
DataSourceObject
containing a dimension
stored at a specific index in this AdvancedCondition
.int getFilterObjectCount()
DataSourceObject
instances used
as filter objects on this AdvancedCondition
.
DataSourceObject
instances in
this AdvancedCondition
filter.DataSourceObject getFilterObject(int index)
DataSourceObject
at index
used to filter
this AdvancedCondition
.
index
- The position of filter object to be retrieved.
index
.
java.lang.IndexOutOfBoundsException
- When index < 0
|| index >= AdvancedCondition.getFilterObjectCount()
void addFilterObject(DataSourceObject dso)
DataSourceObject
to filter
this AdvancedCondition
.
dso
- A DataSourceObject
representing an object in a
Business Objects universe. An example of a universe object used to filter
an AdvancedCondition
is Country in the beach example universe.void removeFilterObject(int index)
AdvancedCondition
object.
index
- The position of filter object in the
AdvancedCondition
tree.
java.lang.IndexOutOfBoundsException
- When index < 0
|| index >= AdvancedCondition.getFilterObjectCount()
int getResultObjectCount()
DataSourceObject
instances in the result part of
the AdvancedCondition
.
DataSourceObject
in the
AdvancedCondition
tree.DataSourceObject getResultObject(int index)
DataSourceObject
at the specific index
in the result part of
the AdvancedCondition
tree.
index
- The position of the result object to be retrieved.
DataSourceObject
at position index
.
java.lang.IndexOutOfBoundsException
- When index < 0
|| index >= AdvancedCondition.getResultObjectCount()
void addResultObject(DataSourceObject dso)
AdvancedCondition
.
dso
- A DataSourceObject
representing an object in a
Business Objects universe. An example of a universe object
is Country in the beach example universe.void removeResultObject(int index)
AdvancedCondition
.
index
- The position of result object to be removed.
java.lang.IndexOutOfBoundsException
- When index < 0
|| index >= getChildCount
.TreeNode
void setConditionOperator(ConditionOperator operator)
ConditionOperator
such as EQUAL
or
NOT_EQUAL
in the AdvancedCondition
tree.
An example of a ConditionOperator in the club example universe is:
when the revenue result in Query1 is
greater than
any occurrence of
Revenue in Query2.
operator
- A ConditionOperator
instance.
java.lang.NullPointerException
- If operator
is
null
.ConditionOperator getConditionOperator()
ConditionOperator
defined in this
AdvancedCondition
object.
An example of a ConditionOperator in the club example universe is:
when the revenue result in Query1 is
greater than
any occurrence of
Revenue in Query2.
ConditionOperator
instance or null
if no
ConditionOperator
has been defined.AdvancedCondition.setConditionOperator(ConditionOperator)
void setComparisonOperator(ComparisonOperator operator)
ComparisonOperator
such as ANY
or ALL
in the AdvancedCondition
tree.
operator
- A ComparaisonOperator
instance.
FilterConditionException
- when the
ConditionOperator
used is
EQUAL
or IN_LIST
or NOT_IN_LIST
and ComparaisonOperator
is different from ANY
.ComparisonOperator getComparisonOperator()
ComparisonOperator
from the AdvancedCondition
tree.
Note: When the
ConditionOperator
used in
an AdvancedCondition
is
EQUAL
or IN_LIST
, do not add a
ComparisonOperator
to the AdvancedCondition
as it will have no effect on the result when the Query
is run.
ComparisonOperator
instance.boolean hasCondition()
true
when at least one ConditionContainer
has been added to this AdvancedCondition
object.
true
when at least one condition has been set.ConditionContainer
,
LogicalOperator
,
AdvancedCondition.createCondition(LogicalOperator)
ConditionContainer getCondition()
ConditionContainer
set in this
AdvancedCondition
.
Note: Business Objects recommends calling AdvancedCondition.hasCondition()
to validate the presence of a ConditionContainer
before
calling this method.
ConditionContainer
or
null
when no condition has been applied to this
AdvancedCondition
.ConditionContainer createCondition(LogicalOperator op)
ConditionContainer
for this advanced condition.
Note: if this AdvancedCondition
already has a
ConditionContainer
it is replaced by this new one.
op
- A LogicalOperator
to be used as a
condition.
ConditionContainer
.ConditionContainer copyCondition(ConditionContainer cont)
cont
and adds it to this advanced condition.
If this advanced condition has already a condition container, that will be replaced with
the new one.
cont
- the ConditionContainer
to be copied.
ConditionContainer
.void removeCondition()
AdvancedCondition
.
AdvancedCondition.createCondition(LogicalOperator)
,
AdvancedCondition.copyCondition(ConditionContainer)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |