com.sas.dataselectors.filters
Interface FilterableItemInterface

All Known Implementing Classes:

DefaultFilterableItem

@SASScope(value="ALL")
public interface FilterableItemInterface

The FilterableItemInterface defines a single filterable item within a data source. A filterable item is something that can have a filter applied to it and should have its own filter model. For example, in an OLAP BusinessQuery, each DataItem may have a filter applied to it and therefore each DataItem can be represented by a FilterableItemInterface.

Method Summary

abstract void	clearFilter() Clears the filter for this item.
abstract java.lang.String	getDescription() Returns the description for this filterable item if available.
abstract java.lang.String	getExpressionText() Returns the text representation of the filter for this filterable item.
abstract java.lang.Object	getFilterableItem() Returns the actual filterable object.
abstract AdvancedFilterModelInterface	getFilterModel() Returns the filter model for this filterable item.
abstract java.lang.String	getLabel() Returns the label for this filterable item.

Method Detail

getLabel

java.lang.String getLabel()

Returns the label for this filterable item.

Returns:

the label for this item

getDescription

java.lang.String getDescription()

Returns the description for this filterable item if available.

Returns:

the description for this item

getExpressionText

java.lang.String getExpressionText()

Returns the text representation of the filter for this filterable item.

Returns:

the expression text

getFilterModel

AdvancedFilterModelInterface getFilterModel()

Returns the filter model for this filterable item.

Returns:

the filter model

getFilterableItem

java.lang.Object getFilterableItem()

Returns the actual filterable object.

Returns:

the native filter object

clearFilter

void clearFilter()

Clears the filter for this item.