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

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BaseSavedSearch>

Direct Known Subclasses:

ECSFSavedSearch

public class BaseSavedSearch
extends java.lang.Object
implements java.lang.Comparable<BaseSavedSearch>, java.io.Serializable

A Saved Search.

Author:

David Groves <david.groves@oracle.com>

See Also:

Serialized Form

Field Summary

protected java.lang.String	_callerContext
protected java.lang.String	_id
protected java.util.List<SearchCategory>	_searchedCategories
protected java.lang.String	_searchName
protected java.lang.String	_searchString

Constructor Summary

protected	BaseSavedSearch() Protected constructor for subclasses.
	BaseSavedSearch(java.lang.String searchString, java.util.List<SearchCategory> categories, java.lang.String searchName, java.lang.String id, java.lang.String callerContext) Construct this class.

Method Summary

int	compareTo(BaseSavedSearch savedSearch) Sort function to sort based on Name independent of case.
boolean	delete() Delete this saved search from wherever it is stored.
boolean	equals(java.lang.Object obj)
java.lang.String	getCallerContext() Get the caller Search Context for this Search.
java.lang.String	getId() Get the search id.
java.util.List<SearchCategory>	getSearchedCategories() Get the search categories.
java.lang.String	getSearchName() Get the search name.
java.lang.String	getSearchString() Get the search String.
int	hashCode()
boolean	rename(java.lang.String newName) Rename this saved search to the given name.
boolean	save() Save this saved search to wherever it is stored.
boolean	update(SearchResult sr) Updates the saved search based upon the details from the search result.

Methods inherited from class java.lang.Object

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

Field Detail

_searchString

protected java.lang.String _searchString

_callerContext

protected java.lang.String _callerContext

_searchedCategories

protected java.util.List<SearchCategory> _searchedCategories

_searchName

protected java.lang.String _searchName

_id

protected java.lang.String _id

Constructor Detail

BaseSavedSearch

protected BaseSavedSearch()

Protected constructor for subclasses.

BaseSavedSearch

public BaseSavedSearch(java.lang.String searchString,
                       java.util.List<SearchCategory> categories,
                       java.lang.String searchName,
                       java.lang.String id,
                       java.lang.String callerContext)

Construct this class.

Parameters:

searchString - user entered search String.

categories - user selected categories. If 'All', this will have been expanded out to the full list.

searchName - name of the search - user entered at some point.

id - internal id (possibly off a sequence).

callerContext - the caller Search Context for this Search. The Search Context is a String which represents to the caller, the context in which the search result will be called. This primarily relates to saved searches, which will be saved with this context, and only saved searches with this context shown to the user.

Method Detail

getSearchedCategories

public java.util.List<SearchCategory> getSearchedCategories()

Get the search categories.

Returns:

search categories.

getSearchName

public java.lang.String getSearchName()

Get the search name.

Returns:

search name.

getId

public java.lang.String getId()

Get the search id.

Returns:

search id.

getSearchString

public java.lang.String getSearchString()

Get the search String.

Returns:

search String.

getCallerContext

public java.lang.String getCallerContext()

Get the caller Search Context for this Search. The Search Context is a String which represents to the caller, the context in which the search result will be called. This primarily relates to saved searches, which will be saved with this context, and only saved searches with this context shown to the user.

Returns:

caller context.

delete

public boolean delete()

Delete this saved search from wherever it is stored.

Returns:

true if delete succeeded, false otherwise.

save

public boolean save()

Save this saved search to wherever it is stored.

Returns:

true if save succeeded, false otherwise.

rename

public boolean rename(java.lang.String newName)

Rename this saved search to the given name.

Parameters:

newName - new name to rename to.

Returns:

true if rename succeeded, false otherwise.

update

public boolean update(SearchResult sr)

Updates the saved search based upon the details from the search result.

Parameters:

sr - the search result to update from

Returns:

true if rename succeeded, false otherwise.

compareTo

public int compareTo(BaseSavedSearch savedSearch)

Sort function to sort based on Name independent of case.

Specified by:

compareTo in interface java.lang.Comparable<BaseSavedSearch>

Parameters:

savedSearch - another search to compare to.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object