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

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

All Implemented Interfaces:

java.io.Serializable

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

A High level collection construct that allows multiple sub SearchResults in an ordered List such as may be used in a multi-tab result.

Author:

David Groves <david.groves@oracle.com>

See Also:

Serialized Form

Constructor Summary

SplitSearchResult(BaseSavedSearch ss, int lastSelectedResultIndex)
Run a saved Search.

SplitSearchResult(java.util.List<SearchCategory> searchCategories, java.util.List<SearchCategory> allSearchableCategories, java.lang.String searchString, java.lang.String callerContext, int lastSelectedResultIndex)
Create the split search.

Method Summary

java.lang.String	getCallerContext() Get the caller Search Context for this Search.
SearchResult	getDisplayedResult() Gets the current results displayed from the cache.
FilteredResultCache	getDisplayedResultCache() Gets the cache of displayed results for the current filter.
java.lang.String	getErrorMessageName() Obtain an error message for the search, for cases where isInError() == true.
java.util.List<SearchCategory>	getPopupSearchCategories() Get the search categories for current result.
java.lang.String	getPopupSearchString() Get the search string to be used in the results popup.
java.util.List<FilteredResultCache>	getSearches() Get the list of searches.
java.lang.String	getSearchName() Gets the name the search was that was run to return this result.
java.lang.String	getSearchString() Gets the search string used to create the result.
boolean	isInError() Is this search in error, that is could not be performed and should not be shown.
boolean	isSearched(int index) Is the result at index searched.
boolean	searchesExist() Are there any searches?
void	setDisplayedResultIndex(int index) Set the displayed result set index and do a search of this subset if not already searched.
void	setPopupSearchCategories(java.util.List<SearchCategory> popupSearchCategoryValue) Set the search categories for current result.
void	setPopupSearchString(java.lang.String popupSearchString) Set the search string to be used in the results popup.
void	setSearchName(java.lang.String searchName) Sets the name of the search run that returned this result.
int	size() How many searches are there, equivalent to the number of tabs to show?

Methods inherited from class java.lang.Object

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

Constructor Detail

SplitSearchResult

public SplitSearchResult(java.util.List<SearchCategory> searchCategories,
                         java.util.List<SearchCategory> allSearchableCategories,
                         java.lang.String searchString,
                         java.lang.String callerContext,
                         int lastSelectedResultIndex)

Create the split search.

Parameters:

searchCategories - categories user has searched.

allSearchableCategories - all possible categories user might search on.

searchString - search String.

callerContext - context of call, usually GLOBAL, but may be passed by team to subset their results.

lastSelectedResultIndex - the last selected result shown - it should be the one initially searched if possible.

SplitSearchResult

public SplitSearchResult(BaseSavedSearch ss,
                         int lastSelectedResultIndex)

Run a saved Search.

Parameters:

ss - the search to run.

lastSelectedResultIndex - tab index to re-run.

Method Detail

getSearches

public java.util.List<FilteredResultCache> getSearches()

Get the list of searches. Used by UI to lay out repeating tabs.

Returns:

List of search results.

searchesExist

public boolean searchesExist()

Are there any searches?

Returns:

true if there are any searches, false otherwise.

size

public int size()

How many searches are there, equivalent to the number of tabs to show?

Returns:

number of search tabs, >=0.

setPopupSearchCategories

public void setPopupSearchCategories(java.util.List<SearchCategory> popupSearchCategoryValue)

Set the search categories for current result.

Parameters:

popupSearchCategoryValue - categories for current result.

getPopupSearchCategories

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

Get the search categories for current result.

Returns:

search categories for current result.

setPopupSearchString

public void setPopupSearchString(java.lang.String popupSearchString)

Set the search string to be used in the results popup.

Parameters:

popupSearchString - results popup search string.

getPopupSearchString

public java.lang.String getPopupSearchString()

Get the search string to be used in the results popup.

Returns:

results popup 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.

setDisplayedResultIndex

public void setDisplayedResultIndex(int index)

Set the displayed result set index and do a search of this subset if not already searched.

Parameters:

index - index to set, must be between 0 and searches.size() - 1.

isSearched

public boolean isSearched(int index)

Is the result at index searched.

Parameters:

index - index.

Returns:

whether the result at index is searched

getDisplayedResultCache

public FilteredResultCache getDisplayedResultCache()

Gets the cache of displayed results for the current filter.

Returns:

the filtered results cache of the results shown

getDisplayedResult

public SearchResult getDisplayedResult()

Gets the current results displayed from the cache.

Returns:

the current resultst being displayed

getSearchString

public java.lang.String getSearchString()

Gets the search string used to create the result.

Returns:

the search string

getSearchName

public java.lang.String getSearchName()

Gets the name the search was that was run to return this result.

Returns:

the name of the search

setSearchName

public void setSearchName(java.lang.String searchName)

Sets the name of the search run that returned this result.

Parameters:

searchName - the name of the search

isInError

public boolean isInError()

Is this search in error, that is could not be performed and should not be shown. Any searches in error would not have any searchResult structures stored.

Returns:

true if in error, false otherwise.

getErrorMessageName

public java.lang.String getErrorMessageName()

Obtain an error message for the search, for cases where isInError() == true.

Returns:

error message capable of showing to user.