com.businessobjects.rebean.wi
Interface FilterConditionObject

All Superinterfaces:
FilterConditionNode, TreeNode
All Known Subinterfaces:
ConditionObject, FilterObject

public interface FilterConditionObject
extends FilterConditionNode

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

The FilterConditionObject interface holds the link to a DataSourceObject or a ReportExpression.

A FilterConditionObject can have an operand, describing what and how to compare to. When the FilterConditionObject is based on a predefined condition, it can never have an operand, in all other cases an operand is obligatory.

A FilterConditionObject has no TreeNode children, its parent is always a (subclass of) FilterConditionContainer.

Example:

+- ConditionContainer(OR)
    |
    +- ConditionObject(DataSourceObject(revenue), FilterCondition(less than 1000000))
    |
    +- ConditionContainer(AND)
        |
        +- ConditionObject(DataSourceObject(year), FilterCondition(equal to 2002))
        |
        +- ConditionObject(DataSourceObject(holiday period))
corresponds to:
[revenue less than 1000000] OR ([year equal to 2002] AND [holiday period])

Note that in this example we use a ConditionContainer, which means that we are working on a condition, which is attached to a query, and can hold predefined conditions.

See Also:
FilterObject, ConditionObject, FilterConditionOperand

Method Summary
 FilterCondition createFilterCondition(Operator op)
          Creates and adds a FilterCondition object to this FilterConditionObject.
 FilterConditionOperand getOperand()
          Gets the FilterConditionOperand, when there is one.
 
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

createFilterCondition

FilterCondition createFilterCondition(Operator op)
                                      throws REException
Creates and adds a FilterCondition object to this FilterConditionObject.

Parameters:
op - the operator to initializa the new FilterCondition object with
Returns:
the new filter condition
Throws:
FilterConditionException - when operator cannot be applied on the DataSourceObject or ReportExpression, or when the DataSourceObject is a predefined condition
java.lang.NullPointerException - when op is null
java.lang.UnsupportedOperationException - when op isn't supported.
REException

getOperand

FilterConditionOperand getOperand()
Gets the FilterConditionOperand, when there is one.

Returns:
the FilterConditionOperand, or null when there is none specified (as is always the case for predefined conditions)
See Also:
ConditionObject.isPreCondition()