Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 7 (11.1.7)

E22562-07

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

java.lang.Object
  extended by oracle.apps.fnd.applcore.globalSearch.ui.BaseRecentSearch
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ECSFRecentSearch

public class BaseRecentSearch
extends java.lang.Object
implements java.io.Serializable

A Recent Search.

See Also:
Serialized Form

Field Summary
protected  java.util.List<SearchCategory> _searchedCategories
          The search Categories stored redundantly.
protected  java.util.List<PersistentSearchFilter> _searchFilters
          The filters of the search.
protected  java.util.Date _searchRunDate
          Date the search was run.
protected  java.lang.String _searchString
          The search String stored redundantly.
protected  boolean _valid
          Is the recent search valid, this is can it be run.
static java.lang.String RECENT_SEARCH_DESCRIPTION
          Description to save recent search under, never shown in Global search UIs.
 
Constructor Summary
protected BaseRecentSearch()
          Default constructor.
protected BaseRecentSearch(AbstractSearchResult sr, java.util.List<SearchCategory> allCats)
          Create a recent search from a recently run search.
 
Method Summary
 boolean delete()
          Delete this recent search from wherever it is stored.
 boolean equals(java.lang.Object object)
          
 java.util.List<SearchCategory> getSearchedCategories()
          Get the searched categories.
 java.util.List<PersistentSearchFilter> getSearchFilters()
          Get the search filters.
 java.lang.String getSearchRunDate()
          Get the search run date formatted in a user friendly way.
 java.lang.String getSearchString()
          Get the recent search String.
 int hashCode()
          
 boolean isValid()
          Is this recent Search valid? Invalid recent searches should be dropped.
 boolean save()
          Save this recent search to wherever it is stored.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RECENT_SEARCH_DESCRIPTION

public static final java.lang.String RECENT_SEARCH_DESCRIPTION
Description to save recent search under, never shown in Global search UIs.

See Also:
Constant Field Values

_searchFilters

protected java.util.List<PersistentSearchFilter> _searchFilters
The filters of the search. This list is essentially a primary key, and will be used in equals() calls to determine if a recent search needs to be replaced.


_searchRunDate

protected java.util.Date _searchRunDate
Date the search was run.


_valid

protected boolean _valid
Is the recent search valid, this is can it be run. If invalid, clients should drop it.


_searchString

protected java.lang.String _searchString
The search String stored redundantly. Also available in the searchFilters.


_searchedCategories

protected java.util.List<SearchCategory> _searchedCategories
The search Categories stored redundantly. Also available in the searchFilters.

Constructor Detail

BaseRecentSearch

protected BaseRecentSearch()
Default constructor. Calling code responsible for setting all values.


BaseRecentSearch

protected BaseRecentSearch(AbstractSearchResult sr,
                           java.util.List<SearchCategory> allCats)
Create a recent search from a recently run search.

Parameters:
sr - recently run search.
allCats - all categories used in search, used in calculation of category filter.
Method Detail

getSearchFilters

public java.util.List<PersistentSearchFilter> getSearchFilters()
Get the search filters.

Returns:
search filters.

isValid

public boolean isValid()
Is this recent Search valid? Invalid recent searches should be dropped.

Returns:
true if valid, false otherwise.

delete

public boolean delete()
Delete this recent search from wherever it is stored.

Returns:
true if delete succeeded, false otherwise.

save

public boolean save()
Save this recent search to wherever it is stored.

Returns:
true if save succeeded, false otherwise.

hashCode

public int hashCode()

Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Overrides:
equals in class java.lang.Object

getSearchString

public java.lang.String getSearchString()
Get the recent search String.

Returns:
recent search String.

getSearchedCategories

public java.util.List<SearchCategory> getSearchedCategories()
Get the searched categories.

Returns:
searched categories.

getSearchRunDate

public java.lang.String getSearchRunDate()
Get the search run date formatted in a user friendly way.

Returns:
fromatted recent search run date.

Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 7 (11.1.7)

E22562-07

Copyright © 2013 Oracle. All Rights Reserved.