com.businessobjects.rebean.wi
Interface FilterObject

All Superinterfaces:
FilterConditionNode, FilterConditionObject, TreeNode

public interface FilterObject
extends FilterConditionObject

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

A FilterObject interface defines filters. The TreeNode parent is always a FilterContainer.

For an example, see FilterConditionObject.

See Also:
FilterContainer

Method Summary
 java.lang.String getCustomID()
          Gets custom identifier previously set using FilterObject.setCustomID(String)
 java.lang.String getCustomType()
          Gets the custom filter type previously set using FilterObject.setCustomType(String).
 ReportExpression getExpr()
          Returns the ReportExpression that this filter object was created with.
 void setCustomID(java.lang.String id)
          Sets a custom identifier to this FilterObject.
 void setCustomType(java.lang.String customType)
          This method marks a FilterObject instance with some custom type.
 
Methods inherited from interface com.businessobjects.rebean.wi.FilterConditionObject
createFilterCondition, getOperand
 
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

getExpr

ReportExpression getExpr()
Returns the ReportExpression that this filter object was created with.

Returns:
the ReportExpression that this filter object was created with
See Also:
FilterContainer.createFilterObject(ReportExpression)

getCustomType

java.lang.String getCustomType()
Gets the custom filter type previously set using FilterObject.setCustomType(String).

Returns:
the custom filter type.
Since:
12.2.0

setCustomType

void setCustomType(java.lang.String customType)
This method marks a FilterObject instance with some custom type. Filters with a custom type using the Operator.EQUAL operator and a constant operand are not added to the drill bar when entering drill mode.

Parameters:
customType - the custom type.
Since:
12.2.0

setCustomID

void setCustomID(java.lang.String id)
Sets a custom identifier to this FilterObject. This identifier may be used later to identify that filter.

Parameters:
id - the custom identifier.
Since:
12.2.0

getCustomID

java.lang.String getCustomID()
Gets custom identifier previously set using FilterObject.setCustomID(String)

Returns:
the custom identifier.
Since:
12.2.0