|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.2) E22562-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.apps.fnd.applcore.globalSearch.ui.managed.GlobalSearchSessionBean
public class GlobalSearchSessionBean
Session related bean for global search. This bean caches Categories and Saved Searchs based on a callerContext. This caller context is user defined, however the GLOBAL context GlobalSearchBean.GLOBAL_SEARCH_CALLER_CONTEXT is defined for the global Search fields in the UIShell header. To set a new caller context, use the setCallerContext() or setGlobalCallerContext() methods. At construction the caller context is set to default.
Field Summary | |
---|---|
static java.lang.String |
_RESULT_TAB_DC
Default DC to use for showing results. |
static java.lang.String |
GLOBAL_SEARCH_CALLER_CONTEXT
Default Global Search Context. |
static java.lang.String |
GS_EMPTY_DC
Empty DC id for popups, used to conserve memory before popups are shown. |
Constructor Summary | |
---|---|
GlobalSearchSessionBean()
Construct the bean. |
Method Summary | |
---|---|
void |
addSavedSearch(java.lang.String searchName)
Add the current search to the saved searches under the given name within the current callerContext. |
boolean |
containsSavedSearch(java.lang.String searchName)
Does the named saved search exist? |
void |
deleteSavedSearch(BaseSavedSearch searchToDelete)
Delete the named saved search. |
void |
ensureConfigurationAndLoadCategories()
Worker method that will test the search setup to determine if it will work, and if so load the list of categories. |
java.util.List<SearchCategory> |
getAllCallerContextCategories()
Get all the categories the user is allowed to see in the current caller context. |
java.util.List<SearchCategory> |
getAllCategories()
Get all the categories, regardless of the caller context. |
java.util.List<SearchCategory> |
getAllGlobalCategories()
Get all the Global categories the user is allowed to see. |
java.lang.String |
getCallerContext()
Get the current Caller Context. |
SearchError |
getCurrentError()
Get the current error. |
WindowSize |
getCustomWindowSize()
Get the window size for the current context. |
SearchError |
getKeywordError()
Get the "no keywords entered" error. |
int |
getLastSelectedSearchTabIndex()
Get the last selected search tab index. |
BaseSavedSearch |
getSavedSearchById(java.lang.String searchId)
Get the saved search under the given id. |
BaseSavedSearch |
getSavedSearchByName(java.lang.String searchName)
Get the saved search under the given name. |
java.util.List<BaseSavedSearch> |
getSavedSearches()
Get a list of all saved searches. |
static AbstractSearchableFactory |
getSearchableFactory()
Get the searchable factory that allows us to create search results. |
java.lang.String |
getSearchResultTabDC0()
Get the DC name for results tab 0. |
java.lang.String |
getSearchResultTabDC1()
Get the DC name for results tab 1. |
java.lang.String |
getSearchResultTabDC2()
Get the DC name for results tab 2. |
java.lang.String |
getSearchResultTabDC3()
Get the DC name for results tab 3. |
java.lang.String |
getSearchResultTabDC4()
Get the DC name for results tab 4. |
java.lang.Object |
getSearchSession()
Get the SearchSession. |
java.lang.String |
getSearchString()
Binding for the Search String from the UIShell page. |
int |
getSearchTabCount()
Get the number of search tabs. |
java.util.List<SearchCategory> |
getSelectedGlobalCategories()
Get the selected global categories. |
BaseSavedSearch |
getTmpPersonalizeSavedSearch()
Getter for a temporary value to store which save search the user selected in the personalize popup. |
java.lang.String |
getTmpPersonalizeSavedSearchRenameValue()
Getter for a temporary value to store what the user entered into the personalize popup when renaming a saved search. |
boolean |
isAllCategoriesSelected()
Whether all of the categories that have been loaded are selected or when there are no categories loaded (i.e. |
boolean |
isIncompleteCategories()
Are the categories we have loaded incomplete? |
boolean |
isSearchConfigurationTested()
Have we even tested that search is setup and enabled. |
boolean |
isSearchConfigured()
Is ecsf setup and enabled. |
boolean |
isSearchEnabled()
Is search present, and setup so the user can see the search fields? |
void |
renameSavedSearch(java.lang.String searchId,
java.lang.String searchName)
Rename old search given by oldSearchId to new name searchName in the current callerContext. |
void |
setCallerContext(java.lang.String callerContext,
java.util.List<SearchCategory> allSearchableCategories)
Set the current caller Context. |
void |
setCallerContext(java.lang.String callerContext,
java.util.List<SearchCategory> allSearchableCategories,
java.awt.Dimension d)
Set the current caller Context. |
void |
setCurrentError(SearchError currentError)
Set the curent error to show the user. |
void |
setGlobalCallerContext()
Set the current caller Context to that of global. |
void |
setKeywordError(SearchError keywordError)
|
void |
setLastSelectedSearchTabIndex(int lastSelectedSearchTabIndex)
Set the last selected search tab index, as determined by the user disclosing tabs. |
static void |
setSearchableFactory(AbstractSearchableFactory searchableFactory)
The SearchableFactory to be used, if null defaults to ECSF. |
void |
setSearchSession(java.lang.Object searchSession)
Get the SearchSession. |
void |
setSearchString(java.lang.String newSearchString)
Binding for the Search String from the UIShell page. |
void |
setSelectedGlobalCategories(java.util.List<SearchCategory> selectedGlobalCategories)
set the selected global categories. |
void |
setTmpPersonalizeSavedSearch(BaseSavedSearch tmpPersonalizeSavedSearch)
Setter for a temporary value to store which save search the user selected in the personalize popup. |
void |
setTmpPersonalizeSavedSearchRenameValue(java.lang.String tmpPersonalizeSavedSearchRenameValue)
Setter for a temporary value to store what the user entered into the personalize popup when renaming a saved search. |
void |
setWindowSize(WindowSize w)
Sets the window Size for the caller Global context. |
void |
updateSavedSearch(BaseSavedSearch searchToUpdate)
Deletes the previous search passed in and replaces it with the current search using the same search name. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String GLOBAL_SEARCH_CALLER_CONTEXT
public static final java.lang.String GS_EMPTY_DC
public static final java.lang.String _RESULT_TAB_DC
Constructor Detail |
---|
public GlobalSearchSessionBean()
Method Detail |
---|
public void ensureConfigurationAndLoadCategories()
This logic is deliberately separate to avoid inline loading of ECSF code which cannot be relied upon (may throw unchecked exceptions or stall for interterminate amounts of time).
public static AbstractSearchableFactory getSearchableFactory()
public static void setSearchableFactory(AbstractSearchableFactory searchableFactory)
searchableFactory
- factory to use. Use null to reset to the default.public java.util.List<SearchCategory> getAllCategories()
public java.util.List<SearchCategory> getAllGlobalCategories()
public java.util.List<SearchCategory> getAllCallerContextCategories()
public java.util.List<BaseSavedSearch> getSavedSearches()
public void deleteSavedSearch(BaseSavedSearch searchToDelete)
searchToDelete
- search to delete.public boolean containsSavedSearch(java.lang.String searchName)
searchName
- name of search.
public BaseSavedSearch getSavedSearchById(java.lang.String searchId)
searchId
- id of search.
public BaseSavedSearch getSavedSearchByName(java.lang.String searchName)
searchName
- name of search.
public void addSavedSearch(java.lang.String searchName)
searchName
- name to use.public void renameSavedSearch(java.lang.String searchId, java.lang.String searchName)
searchId
- id of existing search.searchName
- new name.public void updateSavedSearch(BaseSavedSearch searchToUpdate)
searchToUpdate
- search to update.public boolean isSearchConfigured()
public boolean isSearchConfigurationTested()
public void setCallerContext(java.lang.String callerContext, java.util.List<SearchCategory> allSearchableCategories)
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.allSearchableCategories
- all the categories that are relevant for
this callerContext.public void setCallerContext(java.lang.String callerContext, java.util.List<SearchCategory> allSearchableCategories, java.awt.Dimension d)
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.allSearchableCategories
- all the categories that are relevant for
this callerContext.d
- windowSize to use.public void setWindowSize(WindowSize w)
w
- window size.public WindowSize getCustomWindowSize()
public void setGlobalCallerContext()
public java.lang.String getCallerContext()
public void setSelectedGlobalCategories(java.util.List<SearchCategory> selectedGlobalCategories)
selectedGlobalCategories
- selected global caller scope categories.public boolean isAllCategoriesSelected()
public java.util.List<SearchCategory> getSelectedGlobalCategories()
public void setSearchString(java.lang.String newSearchString)
newSearchString
- Binding for the Search String.public java.lang.String getSearchString()
public void setLastSelectedSearchTabIndex(int lastSelectedSearchTabIndex)
lastSelectedSearchTabIndex
- last selected search tab index.public int getLastSelectedSearchTabIndex()
public void setTmpPersonalizeSavedSearchRenameValue(java.lang.String tmpPersonalizeSavedSearchRenameValue)
tmpPersonalizeSavedSearchRenameValue
- the name the user wants to rename a saved search topublic java.lang.String getTmpPersonalizeSavedSearchRenameValue()
public void setTmpPersonalizeSavedSearch(BaseSavedSearch tmpPersonalizeSavedSearch)
tmpPersonalizeSavedSearch
- the selected search on the personalize dialogpublic BaseSavedSearch getTmpPersonalizeSavedSearch()
public int getSearchTabCount()
public java.lang.String getSearchResultTabDC0()
public java.lang.String getSearchResultTabDC1()
public java.lang.String getSearchResultTabDC2()
public java.lang.String getSearchResultTabDC3()
public java.lang.String getSearchResultTabDC4()
public void setSearchSession(java.lang.Object searchSession)
searchSession
- SearchSession.public java.lang.Object getSearchSession()
public boolean isSearchEnabled()
public void setCurrentError(SearchError currentError)
currentError
- the current error.public SearchError getCurrentError()
public SearchError getKeywordError()
public void setKeywordError(SearchError keywordError)
public boolean isIncompleteCategories()
|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.2) E22562-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |