|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.6) E22562-05 |
|||||||||
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.SearchUtils
public final class SearchUtils
Generic utilities for Global Search.
Field Summary | |
---|---|
static java.lang.String |
BI_ACTIONLINKGROUPNAMEVALUES_ATTR
BI BIACTIONLINKGROUPNAMEVALUES Attribute. |
static java.lang.String |
BI_ACTIONLINKNAMEVALUES_ATTR
BI BIACTIONLINKNAMEVALUES Attribute. |
static java.lang.String |
BI_ACTIONLINKVALUES_ATTR
BI ACTIONLINKVALUES Attribute. |
static java.lang.String |
BI_DESCRIPTION_ATTR
BI DESCRIPTION Attribute. |
static java.lang.String |
BI_EQREDIRECTURL_ATTR
BI EQREDIRECTURL Attribute. |
static java.lang.String |
BI_EQUSERQUERY_ATTR
BI EQUSERQUERY Attribute. |
static java.lang.String |
BI_ICONPATH_ATTR
BI BIICONPATH Attribute. |
static java.lang.String |
BI_NODEAUTHOR_ATTR
BI BINODEAUTHOR Attribute. |
static java.lang.String |
BI_NODEMODIFICATIONDATE_ATTR
BI BINODEMODIFICATIONDATE Attribute. |
static java.lang.String |
BI_TITLE_ATTR
BI TITLE Attribute. |
static java.lang.String |
ECSF_SCOPE_SYSPROP
TODO This property temporary until all teams running with proper security. |
static java.lang.String |
GS_CATEGORY_NOT_ALLOWED
A Search is being run using categories that are not in the list of all allowed categories for this user. |
static java.lang.String |
GS_EMPTY_KEYWORD
A user is trying to search without typing in a keyword. |
static java.lang.String |
GS_MISSING_CATEGORIES
Not all categories are available, search result may be missing results. |
static java.lang.String |
GS_NO_CATEGORIES
An unknown error has occurred, such as an exception when saving search. |
static java.lang.String |
GS_NOT_CONFIGURED
Global Search is not configured. |
static java.lang.String |
GS_SEARCH_WARNING
A warning has been returned on executing a search, results may be incomplete. |
static java.lang.String |
GS_UNKNOWN_ERROR
An unknown arror has occurred, such as an exception when saving search. |
static java.lang.String |
RESULTS_MAIN_PANEL_ID
Search Results Main Panel ID. |
static java.lang.String |
WC_SERVICEID_ATTR
Web Center Service Id. |
static java.lang.String |
WC_URL_ATTR
Web Center URL attribute, sometimes used to return the result destinaion URL when the default action URL cannot be over-riddedn in the SES document pipeline. |
Method Summary | |
---|---|
static void |
clearDtSessionBean()
Reset the design Time session Bean. |
static java.util.Map<java.lang.String,java.lang.String> |
createFacetNameMap(java.lang.String facetName)
Create a collection contining the facet name that may be added to a facet treeItem. |
static void |
discloseFirstTreeLevel(org.apache.myfaces.trinidad.model.TreeModel tm,
org.apache.myfaces.trinidad.model.RowKeySet disclosedRows)
Disclose the first node of the tree if possible. |
static void |
discloseSR(SearchResult sr,
org.apache.myfaces.trinidad.model.RowKeySet disclosedRows)
For the given Search result, add to the disclosed rows any filters, or the default disclosure (first category opened). |
static java.util.List<SearchCategory> |
fillCategories(java.util.List<SearchCategory> allCategories,
java.util.List<SearchCategory> searchCategories)
Examine searchCategories in the light of allCategories and fill it up with categories. |
static void |
focusResultPopup(javax.faces.component.UIComponent c)
Show the popup where the results will be rendered. |
static java.lang.String |
formatDateString(java.lang.String mlsString,
java.util.Date d)
Format theString mlsString, assumed to have one replacement token of the form "Some String {0}" with d formatted to the logged in user's preferences. |
static java.lang.String |
formatMultiDateString(java.lang.String mlsString,
java.util.Date... d)
Format theString mlsString, assumed to have one replacement token of the form "Some String {0}" with d formatted to the logged in user's preferences. |
static java.lang.String |
formatRecentDate(java.util.Date d)
Obtain a String representing the date d relative to "now". |
static java.lang.String |
formatString(java.lang.String mlsString,
java.lang.Object o)
Format the mlsString with 1 replacement paramter. |
static SplitSearchResult |
getCurrentSearchResult()
Get the current search result. |
static java.lang.String |
getFacetName(TreeItem facet)
Get the facet item name for the given tree node, assumed to be of type FACET_ITEM. |
static java.util.Locale |
getLocale()
Get the current Locale for the running page. |
static java.lang.String |
getLoggedInUser()
Get the logged in user name vai standard ADF/JSF APIs. |
static java.lang.Object |
getPageFlowScopeVar(java.lang.String name)
Get a pageFlowScope variable with the given name, null if not found. |
static java.lang.String |
getParameterValue(java.util.Map map,
java.lang.String key)
Get the named parameter from the Map as a String. |
static java.lang.String |
getParameterValue(java.util.Map map,
java.lang.String key,
java.lang.String defaultValue)
Get the named parameter from the Map as a String. |
static GlobalSearchSessionBean |
getSearchSessionBean()
Get the search Session bean. |
static java.lang.String |
getSeededMessageText(java.lang.String messageName)
Get a specific message from the message dictionary. |
static java.lang.String |
getUserLanguage()
Get the user language from the applsession. |
static java.util.TimeZone |
getUserTimezone()
Get the user timezone from the applsession. |
static boolean |
hasBIAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)
Has the attributes Map got BI attributes? |
static boolean |
hasWCAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)
Has the attributes Map got Web Center attributes? |
static void |
hidePopup(javax.faces.component.UIComponent c)
Hide the popup where the results will are rendered. |
static void |
hideSummaryResultsPopups(javax.faces.component.UIComponent c)
An agressive hide of the summary popups so the search has full visibility. |
static boolean |
isAuthenticated()
Is the current User authenticated in ADF? Equivalent to #{securityContext.authenticated}. |
static boolean |
isRTL()
Are we in a right to Left reading envirnoment. |
static boolean |
isSearchEnabled()
Is search enabled. |
static boolean |
isSearchEnabledViaProfile()
Is search enabled via the profile FUSION_APPS_SEARCH_ENABLED. |
static boolean |
isSearchEnabledViaSysprop()
Is search enabled via the java runtime switch FUSION_APPS_SEARCH_ENGINE_AVAILABLE. |
static java.lang.String |
makeHtmlBold(java.lang.String val)
Make replacements in val to turn [[ ]] delimiters into html bold delimiters <b> </b>. |
static void |
refreshLocalResult(javax.faces.component.UIComponent c)
An agressive refresh of the active results area, the header as well as the results table. |
static void |
refreshResults(javax.faces.component.UIComponent c)
PPR refresh the results. |
static void |
refreshSummarySaveCombos(javax.faces.component.UIComponent c)
An agressive refresh of the saved search combos in the search results popup. |
static void |
refreshUnauthenticatedLastResultsIcon(javax.faces.component.UIComponent c)
An agressive refresh of the unauthenticated commandImageLink for showing the last search result. |
static java.lang.Object |
removePageFlowScopeVar(java.lang.String name)
Remove a pageFlowScope variable with the given name. |
static java.lang.String |
replace(java.lang.String oldValue,
java.lang.String compareValue,
java.lang.String newValue)
Replace all instances of compareValue in oldValue with newValue. |
static void |
resetActiveResultsTable(javax.faces.component.UIComponent c)
An agressive reset of the top/display row of the active results table. |
static void |
resetDisclosedTreeState(SearchResult sr)
Clear and reset the tree's disclosed state so that it does not remember any unwanted information about previous searches, then redisclose the first level. |
static void |
resetDisclosedTreeState(SplitSearchResult ssr)
Clear and reset the tree's disclosed state so that it does not remember any unwanted information about previous searches, then redisclose the first level. |
static void |
saveLastResultToPageflowScope(SplitSearchResult currentSearchResult)
Save our search result to the current pageflowScope where they may be retrieved later. |
static void |
saveLastResultToSession(SplitSearchResult ssr)
Save our search result to the session, either pageflowScope if in a taskflow, or the session scope if called from UIShell fields, or API. |
static void |
saveLastResultToSessionScope(SplitSearchResult currentSearchResult)
Save our search result to the current session Scope where they may be retrieved later. |
static java.lang.Object |
setPageFlowScopeVar(java.lang.String name,
java.lang.Object value)
Get a pageFlowScope variable with the given name, null if not found. |
static void |
showConfirmOverwritePersonalizeSearchPopup(oracle.adf.view.rich.component.rich.RichDialog personalizeDialog)
Show the overwrite saved search popup given some component in the component tree. |
static void |
showConfirmOverwriteSavedSearchPopup(oracle.adf.view.rich.component.rich.RichDialog saveDialog)
Show the overwrite saved search popup given some component in the component tree. |
static void |
showKeywordSearchErrorPopup(javax.faces.component.UIComponent c)
Show the keyword search error message popup next to the component provided. |
static void |
showPopup(oracle.adf.view.rich.component.rich.RichPopup popup)
Show the popup. |
static void |
showPopup(oracle.adf.view.rich.component.rich.RichPopup popup,
oracle.adf.view.rich.component.rich.RichPopup.PopupHints hints)
Show the popup. |
static void |
showResultPopup(javax.faces.component.UIComponent c)
Show the popup where the results will be rendered. |
static void |
showSearchResultPersonalizePopup(javax.faces.component.UIComponent c)
Show the personalize popup from the "personalize ..." selection of the saved searches drop box in a tab in the current search results. |
static void |
showSeededError(java.lang.String messageName)
Show a specific error to the user. |
static java.util.List<java.lang.Object> |
toParentRowKey(java.lang.Object rowKey)
Get the row key of the parent of rowKey. |
static java.lang.Object |
toRowKey(java.util.List<TreeItem> rootItems,
TreeItem ti)
Convert ti, a TreeItem at some place in the tree to a row key, the form of which will be an array of Integers corresponding to the index position of ti at each level. |
static java.util.List<SearchCategory> |
toSearchCategories(java.lang.Object searchCategories,
java.util.List<SearchCategory> allCats)
Turn searchCategories into a unique list of SearchCategories. |
static java.lang.String |
toXMLAttr(java.lang.String attr)
Convert attr, which may be null or empty, or contain illegal xml characters into a legal xml value. |
static java.lang.String |
unHtml(java.lang.String val)
Remove basic html markings, <b>, <i>. |
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 GS_EMPTY_KEYWORD
public static final java.lang.String GS_UNKNOWN_ERROR
public static final java.lang.String GS_NO_CATEGORIES
public static final java.lang.String GS_CATEGORY_NOT_ALLOWED
public static final java.lang.String GS_MISSING_CATEGORIES
public static final java.lang.String GS_SEARCH_WARNING
public static final java.lang.String GS_NOT_CONFIGURED
public static final java.lang.String BI_EQREDIRECTURL_ATTR
public static final java.lang.String BI_EQUSERQUERY_ATTR
public static final java.lang.String BI_ICONPATH_ATTR
public static final java.lang.String BI_TITLE_ATTR
public static final java.lang.String BI_NODEMODIFICATIONDATE_ATTR
public static final java.lang.String BI_NODEAUTHOR_ATTR
public static final java.lang.String BI_DESCRIPTION_ATTR
public static final java.lang.String BI_ACTIONLINKGROUPNAMEVALUES_ATTR
public static final java.lang.String BI_ACTIONLINKNAMEVALUES_ATTR
public static final java.lang.String BI_ACTIONLINKVALUES_ATTR
public static final java.lang.String WC_SERVICEID_ATTR
public static final java.lang.String WC_URL_ATTR
public static final java.lang.String RESULTS_MAIN_PANEL_ID
public static final java.lang.String ECSF_SCOPE_SYSPROP
Method Detail |
---|
public static java.lang.String getLoggedInUser()
public static void clearDtSessionBean()
public static GlobalSearchSessionBean getSearchSessionBean()
public static SplitSearchResult getCurrentSearchResult()
public static void saveLastResultToSession(SplitSearchResult ssr)
ssr
- the result to save. Cannot be null.public static void saveLastResultToPageflowScope(SplitSearchResult currentSearchResult)
currentSearchResult
- the result to save. If null, the current result
(if any) will be removed from the current pageflowScope.public static void saveLastResultToSessionScope(SplitSearchResult currentSearchResult)
currentSearchResult
- the result to save. If null, the current result
(if any) will be removed from the current session Scope.public static java.util.List<SearchCategory> fillCategories(java.util.List<SearchCategory> allCategories, java.util.List<SearchCategory> searchCategories)
allCategories
- all categories that are shown.searchCategories
- the selected categories, with the corner case that
"All" as a single List entry (or it is empty), then we return a full List.
public static java.lang.String getParameterValue(java.util.Map map, java.lang.String key, java.lang.String defaultValue)
map
- non-null map possibly containing value for key.key
- non-null key to look for.defaultValue
- value to return if no value
public static java.lang.String getParameterValue(java.util.Map map, java.lang.String key)
map
- possibly null map possibly containing value for key.key
- non-null key to look for.
public static boolean hasBIAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)
attributes
- a non-null, but possibly empty map.
public static boolean hasWCAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)
attributes
- a non-null, but possibly empty map.
public static java.lang.String replace(java.lang.String oldValue, java.lang.String compareValue, java.lang.String newValue)
oldValue
- old value that may or may not contain compareValue.compareValue
- value to replace.newValue
- replacement.
public static java.lang.String makeHtmlBold(java.lang.String val)
val
- value that may or may not have delimiters in it.
public static java.lang.String unHtml(java.lang.String val)
val
- value that may or may not have delimiters in it.
public static void showSeededError(java.lang.String messageName)
messageName
- name of FND seeded message in the FND_MESSAGES_B table.public static java.lang.String getSeededMessageText(java.lang.String messageName)
messageName
- name of FND seeded message in the FND_MESSAGES_B table.
public static java.util.TimeZone getUserTimezone()
public static java.lang.String getUserLanguage()
public static java.lang.String formatDateString(java.lang.String mlsString, java.util.Date d)
mlsString
- String with a single replacement token.d
- date to be inserted into mlsString.
public static java.lang.String formatString(java.lang.String mlsString, java.lang.Object o)
mlsString
- string contiaining 1 {0} token.o
- object to add into string.
public static java.lang.String formatRecentDate(java.util.Date d)
d
- date to compare. Must be in the past.
public static void hideSummaryResultsPopups(javax.faces.component.UIComponent c)
c
- a UI component within the same form as the search summary componentpublic static void resetActiveResultsTable(javax.faces.component.UIComponent c)
c
- some component in the component tree - this component MUST be in
the JSF subtree of the tab being manipulated, as this method will not try
to navigate out of this subtree.public static java.lang.Object toRowKey(java.util.List<TreeItem> rootItems, TreeItem ti)
root 0
+- child 0
+- grandchild 0
+- ti
+- child 1
root 1
then returned array would be [0,0,1]
rootItems
- root of tree. ti must be under one of these TreeItems.ti
- item to get row key for.
public static java.util.List<java.lang.Object> toParentRowKey(java.lang.Object rowKey)
rowKey
- key to row, assumed to be a List<Object>.
public static void resetDisclosedTreeState(SplitSearchResult ssr)
ssr
- search result.public static void resetDisclosedTreeState(SearchResult sr)
sr
- search result.public static void discloseSR(SearchResult sr, org.apache.myfaces.trinidad.model.RowKeySet disclosedRows)
sr
- Search result, including filters.disclosedRows
- continer to add disclosed row keys.public static void discloseFirstTreeLevel(org.apache.myfaces.trinidad.model.TreeModel tm, org.apache.myfaces.trinidad.model.RowKeySet disclosedRows)
tm
- tree model.disclosedRows
- disclosed row key set to add to.public static void refreshSummarySaveCombos(javax.faces.component.UIComponent c)
c
- some component in the component tree.public static void showSearchResultPersonalizePopup(javax.faces.component.UIComponent c)
c
- peer component in the component tree.public static void showConfirmOverwriteSavedSearchPopup(oracle.adf.view.rich.component.rich.RichDialog saveDialog)
saveDialog
- the overwrite save dialog to showpublic static void showConfirmOverwritePersonalizeSearchPopup(oracle.adf.view.rich.component.rich.RichDialog personalizeDialog)
personalizeDialog
- the overwrite save dialog to showpublic static void showKeywordSearchErrorPopup(javax.faces.component.UIComponent c)
c
- some component in the component tree.public static void showResultPopup(javax.faces.component.UIComponent c)
c
- some component in the component tree.public static void focusResultPopup(javax.faces.component.UIComponent c)
c
- some component in the component tree.public static void refreshResults(javax.faces.component.UIComponent c)
c
- some component in the component tree of the result.public static void hidePopup(javax.faces.component.UIComponent c)
c
- some component in the component tree that is a child of the popup.public static void showPopup(oracle.adf.view.rich.component.rich.RichPopup popup, oracle.adf.view.rich.component.rich.RichPopup.PopupHints hints)
popup
- UI Component to popuphints
- the hints for showing the popup.public static void showPopup(oracle.adf.view.rich.component.rich.RichPopup popup)
popup
- UI Component to popuppublic static boolean isSearchEnabled()
public static boolean isSearchEnabledViaSysprop()
public static boolean isSearchEnabledViaProfile()
public static final java.lang.String getFacetName(TreeItem facet)
facet
- tree item.
public static final java.util.Map<java.lang.String,java.lang.String> createFacetNameMap(java.lang.String facetName)
facetName
- name of facet.
public static boolean isRTL()
public static java.lang.Object getPageFlowScopeVar(java.lang.String name)
name
- name of value.
public static java.lang.Object removePageFlowScopeVar(java.lang.String name)
name
- name of value.
public static java.lang.Object setPageFlowScopeVar(java.lang.String name, java.lang.Object value)
name
- name of value.value
- the value itself.
public static final java.util.Locale getLocale()
public static java.util.List<SearchCategory> toSearchCategories(java.lang.Object searchCategories, java.util.List<SearchCategory> allCats)
searchCategories
- may be null, empty String, a csv list of category names,
a list of SearchCategory classesallCats
- a List of all allowed SearchCategories.
public static void refreshLocalResult(javax.faces.component.UIComponent c)
c
- some component in the component tree under the header.public static java.lang.String formatMultiDateString(java.lang.String mlsString, java.util.Date... d)
mlsString
- String with a single replacement token.d
- dates to be inserted into mlsString.
public static final java.lang.String toXMLAttr(java.lang.String attr)
attr
- attr, may be null, empty or contain chars that need escaping.
public static boolean isAuthenticated()
public static void refreshUnauthenticatedLastResultsIcon(javax.faces.component.UIComponent c)
c
- some component in the UIShell header.
|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.6) E22562-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |