com.businessobjects.rebean.wi
Interface Filterable

All Known Subinterfaces:

ReportBlock, ReportCell, ReportContainer, SectionContainer

public interface Filterable

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

Defines methods to add / remove filters on a specific object.

Method Summary

FilterContainer	copyFilter(FilterContainer dataSet) Makes a copy of dataSet and makes that this element's filter container.
FilterContainer	createFilter(LogicalOperator op) Creates a FilterContainer for this element.
FilterContainer	getFilter() Gets the filter container for this element.
boolean	hasFilter() Informs if any filters have been set on this element.
void	removeFilter() Removes any filter container this report element might have.

Method Detail

hasFilter

boolean hasFilter()

Informs if any filters have been set on this element.

Returns:

true when at least one filter has been set

removeFilter

void removeFilter()

Removes any filter container this report element might have.

createFilter

FilterContainer createFilter(LogicalOperator op)

Creates a FilterContainer for this element. This method is the starting point for creating filters. If this element already has a filter container, that will be replaced with the new one.

Parameters:

op - an operator to use when more than one filters are held in the FilterContainer

Returns:

the created FilterContainer

Throws:

java.lang.NullPointerException - when op is null

getFilter

FilterContainer getFilter()

Gets the filter container for this element.

Returns:

the FilterContainer, or null when there is no filter container for this element

copyFilter

FilterContainer copyFilter(FilterContainer dataSet)

Makes a copy of dataSet and makes that this element's filter container. Any existing container will be replaced by dataSet's copy.

Parameters:

dataSet - the container to use for this element

Returns:

the new filter container (the copy of dataSet)