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

E22562-05

oracle.apps.fnd.applcore.globalSearch.ui.managed
Class GlobalSearchBaseBean

java.lang.Object
  extended by oracle.apps.fnd.applcore.globalSearch.ui.managed.GlobalSearchBaseBean
Direct Known Subclasses:
GlobalSearchBean, GlobalSearchPersonalizeBean, GlobalSearchResultsBean, GlobalSearchResultTabBean, GlobalSearchResultTabPersonalizeBean, GlobalSearchSaveBean, GlobalSearchSummaryBean

public class GlobalSearchBaseBean
extends java.lang.Object

Backing bean for global search.

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

Field Summary
protected  GlobalSearchSessionBean _sessionBean
           
 
Constructor Summary
GlobalSearchBaseBean()
          Public constructor.
 
Method Summary
 java.util.List getCallerContextSavedSearches()
          Get a list of the saved searches from the search results area for the current caller Context.
 java.util.List getGlobalContextSavedSearches()
          Get a list of the saved searches from the search results area for the global caller Context.
 boolean getGlobalScopeSearchResultsExist()
          Do any Search Results exist?
 java.lang.String getSearchLabel()
          The text to use as the watermark.
 java.lang.String getSelectedSavedSearch()
          Get the selectedSaved search, always null so ValueChange event will fire.
 GlobalSearchSessionBean getSessionBean()
          Get the session bean attached to this bean.
 boolean isCallerContextSavedSearchesExist()
          Do any Saved searches exist in the current caller context.
 boolean isGlobalContextSavedSearchesExist()
          Do any Saved searches exist in the global caller context.
 boolean isRecentSearchesExist()
          Do any Recent searches exist.
 SplitSearchResult performGlobalContextSavedSearch(int savedSearchIndex)
          Perform a saved search from the uishell summary popup and save the result to the session.
 SplitSearchResult performRecentSearch(int recentSearchIndex)
          Perform a recent search and save the result to the session.
 void refreshSearchUI(SplitSearchResult ssr, javax.faces.component.UIComponent c, boolean showGlobalPopup)
          Refresh the search UI after a search.
protected  SplitSearchResult runSavedSearch(BaseSavedSearch ss)
          Run the base saved search and save the result to the session.
 void setSelectedSavedSearch(java.lang.String selectedSavedSearch)
          Setter to allow the setting of the selected saved search.
 void setSize(oracle.adf.view.rich.render.ClientEvent event)
          Set the size of the search results popup.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_sessionBean

protected GlobalSearchSessionBean _sessionBean
Constructor Detail

GlobalSearchBaseBean

public GlobalSearchBaseBean()
Public constructor. Setup _sessionBean reference.

Method Detail

getSessionBean

public GlobalSearchSessionBean getSessionBean()
Get the session bean attached to this bean.

Returns:
The instance of the session bean created when this bean is instantiated.

getSearchLabel

public java.lang.String getSearchLabel()
The text to use as the watermark.

Returns:
watermark label

setSize

public void setSize(oracle.adf.view.rich.render.ClientEvent event)
Set the size of the search results popup. This is done at runtime so that we can detect the browser window size and be as large as possible.

Parameters:
event - event.

getCallerContextSavedSearches

public java.util.List getCallerContextSavedSearches()
Get a list of the saved searches from the search results area for the current caller Context.

Returns:
list of the saved searches.

getGlobalContextSavedSearches

public java.util.List getGlobalContextSavedSearches()
Get a list of the saved searches from the search results area for the global caller Context.

Returns:
list of the saved searches.

isCallerContextSavedSearchesExist

public boolean isCallerContextSavedSearchesExist()
Do any Saved searches exist in the current caller context.

Returns:
true if there are some, false otherwise.

isGlobalContextSavedSearchesExist

public boolean isGlobalContextSavedSearchesExist()
Do any Saved searches exist in the global caller context.

Returns:
true if there are some, false otherwise.

performGlobalContextSavedSearch

public SplitSearchResult performGlobalContextSavedSearch(int savedSearchIndex)
Perform a saved search from the uishell summary popup and save the result to the session.

Parameters:
savedSearchIndex - index of search to run.
Returns:
search performed.

performRecentSearch

public SplitSearchResult performRecentSearch(int recentSearchIndex)
Perform a recent search and save the result to the session.

Parameters:
recentSearchIndex - index of search to run.
Returns:
search performed.

setSelectedSavedSearch

public void setSelectedSavedSearch(java.lang.String selectedSavedSearch)
Setter to allow the setting of the selected saved search. So as not to retain state, this method does not store the passed value, ensuring that a valueChange event will be fired no matter what is selected.

Parameters:
selectedSavedSearch - saved search.

getSelectedSavedSearch

public java.lang.String getSelectedSavedSearch()
Get the selectedSaved search, always null so ValueChange event will fire.

Returns:
null.

refreshSearchUI

public void refreshSearchUI(SplitSearchResult ssr,
                            javax.faces.component.UIComponent c,
                            boolean showGlobalPopup)
Refresh the search UI after a search. This method also saves the search result to the session.

Parameters:
ssr - search result to show.
c - the UI Component to the results will be displayed within.
showGlobalPopup - do we bring up the global popup.

runSavedSearch

protected SplitSearchResult runSavedSearch(BaseSavedSearch ss)
Run the base saved search and save the result to the session.

Parameters:
ss - the saved search to run.
Returns:
search performed.

isRecentSearchesExist

public boolean isRecentSearchesExist()
Do any Recent searches exist.

Returns:
true if there are some, false otherwise.

getGlobalScopeSearchResultsExist

public boolean getGlobalScopeSearchResultsExist()
Do any Search Results exist?

Returns:
true if so, false otherwise.

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

E22562-05

Copyright © 2012 Oracle. All Rights Reserved.