|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.6) E22562-03 |
|||||||||
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.AbstractSearchableFactory
public abstract class AbstractSearchableFactory
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.
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 |
---|
public static int DEFAULT_MAX_RECENT_SEARCHES
Constructor Detail |
---|
public AbstractSearchableFactory()
Method Detail |
---|
public abstract boolean isSearchingEnabled()
public abstract boolean isWarnings()
public abstract java.util.List<SearchCategory> loadCategories()
public abstract java.util.List<BaseSavedSearch> loadSavedSearches(java.lang.String callerContext)
callerContext
- caller context.
public boolean isRecentSearchesEnabled()
public int getMaxRecentSearches()
isRecentSearchesEnabled()
public abstract java.util.List<BaseRecentSearch> loadRecentSearches()
public abstract BaseRecentSearch createRecentSearch(SearchResult sr, java.util.List<SearchCategory> allCats)
sr
- existing search result as shown in the currently selected results
tab.allCats
- all categories the user searched with.
public abstract SearchResult createRecentSearchResult(BaseRecentSearch rs, CategoryGroup cg, java.lang.String searchString, boolean performInitialSearch)
rs
- recent search to run.cg
- the Category grouping for this search.searchString
- user entered search string.performInitialSearch
- do we perform an initial search.
public abstract SearchResult createSearchResult(CategoryGroup cg, java.lang.String searchString, java.lang.String callerContext, boolean performInitialSearch)
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.
public abstract SearchResult createSavedSearchResult(BaseSavedSearch ss, CategoryGroup cg, java.lang.String searchString, java.lang.String callerContext, boolean performInitialSearch)
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.
public abstract BaseSavedSearch createSavedSearch(java.lang.String searchName, SearchResult sr)
searchName
- name of search.sr
- existing search result as shown in the currently selected results
tab.
|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.6) E22562-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |