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

E22562-02

oracle.apps.fnd.applcore.globalSearch.ui.ecsf
Class ECSFSearchableFactory

java.lang.Object
  extended by oracle.apps.fnd.applcore.globalSearch.ui.AbstractSearchableFactory
      extended by oracle.apps.fnd.applcore.globalSearch.ui.ecsf.ECSFSearchableFactory

public class ECSFSearchableFactory
extends AbstractSearchableFactory

A concrete (and the default) implementation of AbstractSearchableFactory for creating a specific searchable implementation for ECSF. See GoF Abstract Factory pattern.

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

Constructor Summary
ECSFSearchableFactory()
          Default constructor.
 
Method Summary
 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.
 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.
 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.
 boolean isSearchingEnabled()
          Is searching enabled, that is is whatever search system has been setup been configured and works.
 boolean isWarnings()
          Were there warnings with the last operation?
 java.util.List<SearchCategory> loadCategories()
          Load categories to be shown in Global Search UI.
 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

ECSFSearchableFactory

public ECSFSearchableFactory()
Default constructor.

Method Detail

isSearchingEnabled

public boolean isSearchingEnabled()
Is searching enabled, that is is whatever search system has been setup been configured and works.

Specified by:
isSearchingEnabled in class AbstractSearchableFactory
Returns:
true if enabled, false otherwise.

isWarnings

public boolean isWarnings()
Were there warnings with the last operation?

Specified by:
isWarnings in class AbstractSearchableFactory
Returns:
true if warnings, false otherwise.

loadCategories

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

Specified by:
loadCategories in class AbstractSearchableFactory
Returns:
an non-null, but possibly emty list of categories.

loadSavedSearches

public java.util.List<BaseSavedSearch> loadSavedSearches(java.lang.String callerContext)
Load the saved searches on startup.

Specified by:
loadSavedSearches in class AbstractSearchableFactory
Parameters:
callerContext - caller context.
Returns:
a non-null, but possibly empty List of Saved Searches.

createSearchResult

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

Specified by:
createSearchResult in class AbstractSearchableFactory
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 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.

Specified by:
createSavedSearchResult in class AbstractSearchableFactory
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 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.

Specified by:
createSavedSearch in class AbstractSearchableFactory
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.