oracle.apps.fnd.applcore.globalSearch.ui
Class SearchFilterItem

java.lang.Object
  oracle.apps.fnd.applcore.globalSearch.ui.SearchFilterItem

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CategorySearchFilterItem, DateRangeFilterItem, FacetItemSearchFilterItem, KeywordSearchFilterItem, SearchableObjectSearchFilterItem

public abstract class SearchFilterItem
extends java.lang.Object
implements java.io.Serializable

An abstract class representing a filter item.

Author:

David Groves <david.groves@oracle.com>

See Also:

CategorySearchFilterItem, KeywordSearchFilterItem, FacetItemSearchFilterItem, Serialized Form

Nested Class Summary

static class

SearchFilterItem.FilterType Type of filter.

Field Summary

static int	MAX_TILE_STR_LEN Maximum length of a value to display on a tile.
static java.lang.String	SEP_CHARS The separation characters.

Constructor Summary

SearchFilterItem(SearchFilterItem.FilterType filterType)
Construct this class setting the filter type.

Method Summary

abstract SearchFilterItem	copy() Create a defensive copy of the SearchFilter Item.
abstract java.lang.Object	getAdaptee() Get the object adapted to (in the case where we are adapting to objects in a foreign API).
abstract java.lang.String	getDisplayValue() Get the display value of this filter item.
SearchFilterItem.FilterType	getFilterType() Get the filter Type.
abstract java.lang.String	getToolTipValue() Get the value of this filter item shown in a tooltip.
abstract java.lang.String	getValue() Get the code value of this filter item.
boolean	isApplied() Has this filter been applied?
boolean	isDeletable() Is this filter item 'deletable'.
boolean	isSegmented() Is this facet segmented, that is it to be shown like a breadcrumb:
void	setApplied(boolean applied) Set the application status of this filter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_TILE_STR_LEN

public static final int MAX_TILE_STR_LEN

Maximum length of a value to display on a tile.

See Also:

Constant Field Values

SEP_CHARS

public static final java.lang.String SEP_CHARS

The separation characters.

See Also:

Constant Field Values

Constructor Detail

SearchFilterItem

public SearchFilterItem(SearchFilterItem.FilterType filterType)

Construct this class setting the filter type.

Parameters:

filterType - filter type.

Method Detail

copy

public abstract SearchFilterItem copy()

Create a defensive copy of the SearchFilter Item.

Returns:

a copy of this.

isDeletable

public boolean isDeletable()

Is this filter item 'deletable'. This controls whether the 'X' is shown to the user in the UI.

Returns:

true if deletable, false otherwise.

getFilterType

public SearchFilterItem.FilterType getFilterType()

Get the filter Type.

Returns:

filter Type.

getValue

public abstract java.lang.String getValue()

Get the code value of this filter item.

Returns:

code value of this filter item.

getDisplayValue

public abstract java.lang.String getDisplayValue()

Get the display value of this filter item.

Returns:

display value of this filter item.

getToolTipValue

public abstract java.lang.String getToolTipValue()

Get the value of this filter item shown in a tooltip.

Returns:

tooltip value of this filter item.

getAdaptee

public abstract java.lang.Object getAdaptee()

Get the object adapted to (in the case where we are adapting to objects in a foreign API). See GoF Adapter pattern.

Returns:

Adapted Object.

isSegmented

public boolean isSegmented()

Is this facet segmented, that is it to be shown like a breadcrumb:

 +-------------------------------------+
 | Attribute1: Value1.1 > Value1.1.1 X |
 +-------------------------------------+
 

where Value1.1 is an active commandlink and Value1.1.1 is not.

Returns:

whether facet is segmented

setApplied

public void setApplied(boolean applied)

Set the application status of this filter.

Parameters:

applied - - true if filter is applied, false otherwise.

isApplied

public boolean isApplied()

Has this filter been applied?

Returns:

true if filter is applied, false otherwise.