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

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

Direct Known Subclasses:

ECSFSearchableFactory

public abstract class AbstractSearchableFactory
extends java.lang.Object

An abstract Factory for creating specific searchable implementations. Using this pattern allows the runtime plug-in of arbitrary search sources, something that has always been (at least a pseudo) requirement, but certainly extremely useful for unit testing. See GoF Abstract Factory pattern.

See Also:

ECSFSearchableFactory

Field Summary

static int

DEFAULT_MAX_RECENT_SEARCHES The default maximum number of recent searches.

Constructor Summary

AbstractSearchableFactory()

Method Summary

abstract BaseRecentSearch	createRecentSearch(SearchResult sr, java.util.List<SearchCategory> allCats) Turn a search result into a bean representing the recent search such that it can be stored in the list of recent searches.
abstract SearchResult	createRecentSearchResult(BaseRecentSearch rs, CategoryGroup cg, java.lang.String searchString, boolean performInitialSearch) Create a specific Search result for the given arguments for the search strategy.
abstract BaseSavedSearch	createSavedSearch(java.lang.String searchName, SearchResult sr) Turn a search result into a bean representing the saved search of given name, such that it can be stored in the list of saved searches.
abstract SearchResult	createSavedSearchResult(BaseSavedSearch ss, CategoryGroup cg, java.lang.String searchString, java.lang.String callerContext, boolean performInitialSearch) Create a specific Search result for the given arguments for the search strategy.
abstract SearchResult	createSearchResult(CategoryGroup cg, java.lang.String searchString, java.lang.String callerContext, boolean performInitialSearch) Create a specific Search result for the given arguments for the search strategy.
int	getMaxRecentSearches() Get the maximum number of recent searches allowed.
boolean	isRecentSearchesEnabled() Is the recent search feature enabled? By default is enabled if searching is enabled.
abstract boolean	isSearchingEnabled() Is searching enabled, that is is whatever search system has been setup been configured and works.
abstract boolean	isWarnings() Were there warnings with the last operation?
abstract java.util.List<SearchCategory>	loadCategories() Load categories to be shown in Global Search UI.
abstract java.util.List<BaseRecentSearch>	loadRecentSearches() Load the recent searches on startup.
abstract java.util.List<BaseSavedSearch>	loadSavedSearches(java.lang.String callerContext) Load the saved searches on startup.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_RECENT_SEARCHES

public static int DEFAULT_MAX_RECENT_SEARCHES

The default maximum number of recent searches.

Constructor Detail

AbstractSearchableFactory

public AbstractSearchableFactory()

Method Detail

isSearchingEnabled

public abstract boolean isSearchingEnabled()

Is searching enabled, that is is whatever search system has been setup been configured and works.

Returns:

true if enabled, false otherwise.

isWarnings

public abstract boolean isWarnings()

Were there warnings with the last operation?

Returns:

true if warnings, false otherwise.

loadCategories

public abstract java.util.List<SearchCategory> loadCategories()

Load categories to be shown in Global Search UI. They will be filtered for GLOBAL context at a later point, but order preserved, and will be shown in the order returned.

Returns:

an non-null, but possibly emty list of categories.

loadSavedSearches

public abstract java.util.List<BaseSavedSearch> loadSavedSearches(java.lang.String callerContext)

Load the saved searches on startup.

Parameters:

callerContext - caller context.

Returns:

a non-null, but possibly empty List of Saved Searches.

isRecentSearchesEnabled

public boolean isRecentSearchesEnabled()

Is the recent search feature enabled? By default is enabled if searching is enabled.

Returns:

true if enabled, false otherwise.

getMaxRecentSearches

public int getMaxRecentSearches()

Get the maximum number of recent searches allowed. It is assumed isRecentSearchesEnabled() returns true.

Returns:

maximum number of recent searches allowed, by default 10;

See Also:

isRecentSearchesEnabled()

loadRecentSearches

public abstract java.util.List<BaseRecentSearch> loadRecentSearches()

Load the recent searches on startup.

Returns:

a non-null, but possibly empty List of Recent Searches.

createRecentSearch

public abstract BaseRecentSearch createRecentSearch(SearchResult sr,
                                                    java.util.List<SearchCategory> allCats)

Turn a search result into a bean representing the recent search such that it can be stored in the list of recent searches.

Parameters:

sr - existing search result as shown in the currently selected results tab.

allCats - all categories the user searched with.

Returns:

RecentSearch representing the search.

createRecentSearchResult

public abstract SearchResult createRecentSearchResult(BaseRecentSearch rs,
                                                      CategoryGroup cg,
                                                      java.lang.String searchString,
                                                      boolean performInitialSearch)

Create a specific Search result for the given arguments for the search strategy.

Parameters:

rs - recent search to run.

cg - the Category grouping for this search.

searchString - user entered search string.

performInitialSearch - do we perform an initial search.

Returns:

a Search Result.

createSearchResult

public abstract SearchResult createSearchResult(CategoryGroup cg,
                                                java.lang.String searchString,
                                                java.lang.String callerContext,
                                                boolean performInitialSearch)

Create a specific Search result for the given arguments for the search strategy.

Parameters:

cg - the Category grouping for this search.

searchString - user entered search string.

callerContext - 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.

performInitialSearch - do we perform an initial search.

Returns:

a Search Result.

createSavedSearchResult

public abstract SearchResult createSavedSearchResult(BaseSavedSearch ss,
                                                     CategoryGroup cg,
                                                     java.lang.String searchString,
                                                     java.lang.String callerContext,
                                                     boolean performInitialSearch)

Create a specific Search result for the given arguments for the search strategy.

Parameters:

ss - saved search to run.

cg - the Category grouping for this search.

searchString - user entered search string.

callerContext - 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.

performInitialSearch - do we perform an initial search.

Returns:

a Search Result.

createSavedSearch

public abstract BaseSavedSearch createSavedSearch(java.lang.String searchName,
                                                  SearchResult sr)

Turn a search result into a bean representing the saved search of given name, such that it can be stored in the list of saved searches.

Parameters:

searchName - name of search.

sr - existing search result as shown in the currently selected results tab.

Returns:

Base Saved Search.