oracle.apps.fnd.applcore.globalSearch.util
Class GlobalSearchUtil

java.lang.Object
  oracle.apps.fnd.applcore.globalSearch.util.GlobalSearchUtil

public final class GlobalSearchUtil
extends java.lang.Object

Utility class designed to be used in conjunction with a backing bean to a page component, that will allow that component to kick off a Global Search and display the Global Search Results window. Only usable if the component is on a page that is running inside of a UIShell for example a UIShellMainArea. template.

Author:

James Hayne <james.hayne@oracle.com>

Method Summary

static java.util.List<SearchCategory>	getCategories() Get a list of all the SearchCategory objects.
static void	runSearch(java.util.List<SearchCategory> searchCategories, java.util.List<SearchCategory> allCategories, java.lang.String searchString, java.lang.String callerContext, javax.faces.event.ActionEvent e, java.awt.Dimension popupDimension) Run a search from a backing bean and have the search results ui component display at a set size.
static void	runSearch(java.util.List<SearchCategory> searchCategories, java.lang.String searchString, java.lang.String callerContext, javax.faces.event.ActionEvent e) Run a search from a backing bean and have the search results ui component display.
static void	runSearch(java.util.List<SearchCategory> searchCategories, java.lang.String searchString, java.lang.String callerContext, javax.faces.event.ActionEvent e, java.awt.Dimension popupDimension) Run a search from a backing bean and have the search results ui component display at a set size.

Methods inherited from class java.lang.Object

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

Method Detail

runSearch

public static void runSearch(java.util.List<SearchCategory> searchCategories,
                             java.lang.String searchString,
                             java.lang.String callerContext,
                             javax.faces.event.ActionEvent e)

Run a search from a backing bean and have the search results ui component display.

Parameters:

searchCategories - A list of SearchCategory objects to search within. Can be obtained by calling getCategories() from this class.

searchString - The string to search on

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.

e - The ActionEvent from the page UIComponent that triggered this functionality.

runSearch

public static void runSearch(java.util.List<SearchCategory> searchCategories,
                             java.lang.String searchString,
                             java.lang.String callerContext,
                             javax.faces.event.ActionEvent e,
                             java.awt.Dimension popupDimension)

Run a search from a backing bean and have the search results ui component display at a set size.

Parameters:

searchCategories - A list of SearchCategory objects to search within. Can be obtained by calling getCategories() from this class.

searchString - The string to search on

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.

e - The ActionEvent from the page UIComponent that triggered this functionality.

popupDimension - A Dimension object containing the height and width to display the search results popup.

runSearch

public static void runSearch(java.util.List<SearchCategory> searchCategories,
                             java.util.List<SearchCategory> allCategories,
                             java.lang.String searchString,
                             java.lang.String callerContext,
                             javax.faces.event.ActionEvent e,
                             java.awt.Dimension popupDimension)

Run a search from a backing bean and have the search results ui component display at a set size.

Parameters:

searchCategories - A list of SearchCategory objects to search within. Can be obtained by calling getCategories() from this class. It is expected that this list is a subset of allCategories.

allCategories - A list of all the SearchCategory objects to search within. Can be obtained by calling getCategories() from this class.

searchString - The string to search on

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.

e - The ActionEvent from the page UIComponent that triggered this functionality.

popupDimension - A Dimension object containing the height and width to display the search results popup.

getCategories

public static java.util.List<SearchCategory> getCategories()

Get a list of all the SearchCategory objects.

Returns:

A List of SearchCategory objects containing all possible search categories.