|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.6) E22562-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.apps.fnd.applcore.globalSearch.ui.PersistentSearchFilter
public final class PersistentSearchFilter
An immutable simple bean class that encapsulates a search filter consisting of a type, label, value and displayValue. This is very similar to a FilterItem but is designed to be less UI specific (SearchFilterItems are bound to search tiles UI in the results header), and light weight enough to be persisted to the database for saved and recent searches in the form of an XML snippet.
PersistentSearchFilters are created from the search result SearchFilterItems (the search tiles, which are in effect the PK of the search). PersistentSearchFilters are Global Search's addition to ecsf QueryMetaData, and act as a simple, ordered, fast way of showing search filters to the user. They also add metadata that is difficult to derive from ecsf qmd, specifically
The PersistentSearchFilter is stored as a compressed xml format (internal and private to Global Search) that is stored in the saved search description (1000 chars).
Constructor Summary | |
---|---|
PersistentSearchFilter(SearchFilterItem.FilterType filterType,
java.lang.String label,
java.lang.String value,
java.lang.String displayValue)
Construct this class. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object object)
|
static PersistentSearchFilter |
fromXML(org.w3c.dom.Element e)
Factory method to turn this element into a filter. |
static void |
fromXML(java.lang.String xml,
java.util.List<PersistentSearchFilter> searchFilters)
Factory method to turn a xml snippet into a List of PersistentSearchFilter. |
java.lang.String |
getDisplayValue()
Get the display value. |
SearchFilterItem.FilterType |
getFilterType()
Get the filter type. |
java.lang.String |
getLabel()
Get the Label. |
java.lang.String |
getValue()
Get the value. |
int |
hashCode()
|
java.lang.String |
toXML()
Turn this class into an xml element String. |
static java.lang.String |
toXML(java.util.List<PersistentSearchFilter> searchFilters)
Factory method to turn a list of filters into an xml snippet String. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PersistentSearchFilter(SearchFilterItem.FilterType filterType, java.lang.String label, java.lang.String value, java.lang.String displayValue)
filterType
- type of filter.label
- label.value
- value.displayValue
- user shown value;Method Detail |
---|
public java.lang.String getLabel()
public java.lang.String getValue()
public SearchFilterItem.FilterType getFilterType()
public java.lang.String getDisplayValue()
public java.lang.String toXML()
public static PersistentSearchFilter fromXML(org.w3c.dom.Element e)
e
- expected to be a filter element.
public boolean equals(java.lang.Object object)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public static java.lang.String toXML(java.util.List<PersistentSearchFilter> searchFilters)
searchFilters
- filters to xmlise.
public static void fromXML(java.lang.String xml, java.util.List<PersistentSearchFilter> searchFilters)
xml
- non-null xml snippet.searchFilters
- filter list to fill.
|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.6) E22562-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |