Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.2)

E22562-02

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

java.lang.Object
  extended by 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.

Author:
David Groves <david.groves@oracle.com>
See Also:
ECSFSearchableFactory

Constructor Summary
AbstractSearchableFactory()
           
 
Method Summary
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.
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<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
 

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.

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.

Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.2)

E22562-02

Copyright © 2011 Oracle. All Rights Reserved.