|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.6) E22562-03 |
|||||||||
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.SplitSearchResult
public class SplitSearchResult
A High level collection construct that allows multiple sub SearchResults in an ordered List such as may be used in a multi-tab result.
Constructor Summary | |
---|---|
SplitSearchResult(BaseRecentSearch rs,
int lastSelectedResultIndex)
Run a recent Search. |
|
SplitSearchResult(BaseSavedSearch ss,
int lastSelectedResultIndex)
Run a saved Search. |
|
SplitSearchResult(java.util.List<SearchCategory> searchCategories,
java.util.List<SearchCategory> allSearchableCategories,
java.lang.String searchString,
java.lang.String callerContext,
int lastSelectedResultIndex)
Create the split search. |
Method Summary | |
---|---|
java.util.List<java.lang.String> |
getAlternateWords()
Get any alternate words for the displayed result. |
java.lang.String |
getCallerContext()
Get the caller Search Context for this Search. |
SearchResult |
getDisplayedResult()
Gets the current results displayed from the cache. |
FilteredResultCache |
getDisplayedResultCache()
Gets the cache of displayed results for the current filter. |
java.lang.String |
getErrorMessageName()
Obtain an error message for the search, for cases where isInError() == true. |
java.util.List<SearchCategory> |
getPopupSearchCategories()
Get the search categories for current result. |
java.lang.String |
getPopupSearchString()
Get the search string to be used in the results popup. |
java.util.List<FilteredResultCache> |
getSearches()
Get the list of searches. |
java.lang.String |
getSearchName()
Gets the name the search was that was run to return this result. |
java.lang.String |
getSearchString()
Gets the search string used to create the result. |
boolean |
isAnyAlternateWords()
Are there any alternate words for the displayed result? |
boolean |
isInError()
Is this search in error, that is could not be performed and should not be shown. |
boolean |
isSearched(int index)
Is the result at index searched. |
boolean |
searchesExist()
Are there any searches? |
void |
setDisplayedResultIndex(int index)
Set the displayed result set index and do a search of this subset if not already searched. |
void |
setPopupSearchCategories(java.util.List<SearchCategory> popupSearchCategoryValue)
Set the search categories for current result. |
void |
setPopupSearchString(java.lang.String popupSearchString)
Set the search string to be used in the results popup. |
void |
setSearchName(java.lang.String searchName)
Sets the name of the search run that returned this result. |
int |
size()
How many searches are there, equivalent to the number of tabs to show? |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SplitSearchResult(java.util.List<SearchCategory> searchCategories, java.util.List<SearchCategory> allSearchableCategories, java.lang.String searchString, java.lang.String callerContext, int lastSelectedResultIndex)
searchCategories
- categories user has searched.allSearchableCategories
- all possible categories user might search on.searchString
- search String.callerContext
- context of call, usually GLOBAL, but may be passed by
team to subset their results.lastSelectedResultIndex
- the last selected result shown - it should
be the one initially searched if possible.public SplitSearchResult(BaseSavedSearch ss, int lastSelectedResultIndex)
ss
- the search to run.lastSelectedResultIndex
- tab index to re-run.public SplitSearchResult(BaseRecentSearch rs, int lastSelectedResultIndex)
rs
- the search to run.lastSelectedResultIndex
- tab index to re-run.Method Detail |
---|
public java.util.List<FilteredResultCache> getSearches()
public boolean searchesExist()
public int size()
public void setPopupSearchCategories(java.util.List<SearchCategory> popupSearchCategoryValue)
popupSearchCategoryValue
- categories for current result.public java.util.List<SearchCategory> getPopupSearchCategories()
public void setPopupSearchString(java.lang.String popupSearchString)
popupSearchString
- results popup search string.public java.lang.String getPopupSearchString()
public java.lang.String getCallerContext()
public void setDisplayedResultIndex(int index)
index
- index to set, must be between 0 and searches.size() - 1.public boolean isSearched(int index)
index
- index.
public FilteredResultCache getDisplayedResultCache()
public SearchResult getDisplayedResult()
public java.lang.String getSearchString()
public java.lang.String getSearchName()
public void setSearchName(java.lang.String searchName)
searchName
- the name of the searchpublic boolean isInError()
public java.lang.String getErrorMessageName()
public boolean isAnyAlternateWords()
public java.util.List<java.lang.String> getAlternateWords()
|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.6) E22562-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |