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

java.lang.Object
  oracle.apps.fnd.applcore.globalSearch.ui.managed.GlobalSearchBaseBean
      oracle.apps.fnd.applcore.globalSearch.ui.managed.GlobalSearchBean

public class GlobalSearchBean
extends GlobalSearchBaseBean

Backing bean for global search components in UIShell.

Author:

David Groves <david.groves@oracle.com>

Field Summary

Fields inherited from class oracle.apps.fnd.applcore.globalSearch.ui.managed.GlobalSearchBaseBean

_sessionBean

Constructor Summary

GlobalSearchBean()
Public constructor for managed bean.

Method Summary

java.util.List<javax.faces.model.SelectItem>	getAllGlobalCategories() Get all Global categories in a form the JSF widget can understand.
oracle.adf.view.rich.component.rich.input.RichInputText	getGlobalSearchField() Binding for the UIShell Global search field.
oracle.adf.view.rich.component.rich.input.RichSelectManyChoice	getSearchCategories() Binding for the Search Categories.
java.util.List<java.lang.String>	getSearchCategoryValue() Bound method to UI.
java.lang.String	getSearchString() Binding for the Search String.
java.lang.String[]	getSelectedCategoryLabels() Method bound to to the category multi select to indicate the default labels to be shown, in our case "All".
boolean	isManyGlobalCategories() Do we have more than 1 global category?
boolean	isSearchConfigurationTested() Have we even tested that search is setup and enabled.
boolean	isSearchEnabled() Is search enabled?
static SplitSearchResult	performSearch(java.util.List<SearchCategory> searchCategories, java.lang.String searchString) Perform a search from the main UIShell search area and save the result to the session.
void	searchResults(javax.faces.event.ActionEvent e) Perform a search from the UI in the UIShell page.
void	setGlobalCallerContext(oracle.adf.view.rich.render.ClientEvent event) Set callerContext to Global, that is we are interacting with the UIShell search fields and need to work with the global categories and saved searches.
void	setGlobalSearchField(oracle.adf.view.rich.component.rich.input.RichInputText globalSearchField) Binding for the UIShell Global search field.
void	setSearchCategories(oracle.adf.view.rich.component.rich.input.RichSelectManyChoice selectManyChoice) Binding for the Search Categories.
void	setSearchCategoryValue(java.util.List<java.lang.String> val) Set the Search Category Values from a List of String Ids for caller Context of global.
void	setSearchString(java.lang.String newSearchString) Binding for the Search String.

Methods inherited from class oracle.apps.fnd.applcore.globalSearch.ui.managed.GlobalSearchBaseBean

getSavedSearches, getSearchLabel, getSelectedSavedSearch, getSessionBean, isSavedSearchesExist, performSavedSearch, refreshSearchUI, savedSearchSelectionChanged, setSelectedSavedSearch, setSize

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalSearchBean

public GlobalSearchBean()

Public constructor for managed bean.

Method Detail

performSearch

public static SplitSearchResult performSearch(java.util.List<SearchCategory> searchCategories,
                                              java.lang.String searchString)

Perform a search from the main UIShell search area and save the result to the session.

Parameters:

searchCategories - categories to search.

searchString - user-entered search string.

Returns:

search performed, null if not able to perform search.

isManyGlobalCategories

public boolean isManyGlobalCategories()

Do we have more than 1 global category?

Returns:

true if there is more than one global category.

isSearchConfigurationTested

public boolean isSearchConfigurationTested()

Have we even tested that search is setup and enabled. Use this method to test whether search is setup, without triggering search code.

Returns:

true if search config has been tested, false otherwise.

getSelectedCategoryLabels

public java.lang.String[] getSelectedCategoryLabels()

Method bound to to the category multi select to indicate the default labels to be shown, in our case "All".

Returns:

singleton Array contining "_ALL_" token which ADFv recognises as "All" in MLS translated env.

getAllGlobalCategories

public java.util.List<javax.faces.model.SelectItem> getAllGlobalCategories()

Get all Global categories in a form the JSF widget can understand.

Returns:

Search categories.

getSearchCategoryValue

public java.util.List<java.lang.String> getSearchCategoryValue()

Bound method to UI.

Returns:

List of Search Category Value Strings.

setSearchCategoryValue

public void setSearchCategoryValue(java.util.List<java.lang.String> val)

Set the Search Category Values from a List of String Ids for caller Context of global.

Parameters:

val - List of String Ids representing the JSF widget submit values.

searchResults

public void searchResults(javax.faces.event.ActionEvent e)

Perform a search from the UI in the UIShell page.

Parameters:

e - event.

setGlobalCallerContext

public void setGlobalCallerContext(oracle.adf.view.rich.render.ClientEvent event)

Set callerContext to Global, that is we are interacting with the UIShell search fields and need to work with the global categories and saved searches.

Parameters:

event - event.

setSearchCategories

public void setSearchCategories(oracle.adf.view.rich.component.rich.input.RichSelectManyChoice selectManyChoice)

Binding for the Search Categories.

Parameters:

selectManyChoice - Search Categories.

getSearchCategories

public oracle.adf.view.rich.component.rich.input.RichSelectManyChoice getSearchCategories()

Binding for the Search Categories.

Returns:

Search Categories.

setGlobalSearchField

public void setGlobalSearchField(oracle.adf.view.rich.component.rich.input.RichInputText globalSearchField)

Binding for the UIShell Global search field.

Parameters:

globalSearchField - Binding for the UIShell Global search field.

getGlobalSearchField

public oracle.adf.view.rich.component.rich.input.RichInputText getGlobalSearchField()

Binding for the UIShell Global search field.

Returns:

Binding for the UIShell Global search field.

setSearchString

public void setSearchString(java.lang.String newSearchString)

Binding for the Search String.

Parameters:

newSearchString - Binding for the Search String.

getSearchString

public java.lang.String getSearchString()

Binding for the Search String.

Returns:

Binding for the Search String.

isSearchEnabled

public boolean isSearchEnabled()

Is search enabled?

Returns:

true if search enabled, false otherwise.