|
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.AbstractSearchResult
public abstract class AbstractSearchResult
An abstract base class for Search Results. All implementation classes MUST extend this abstract class and not implement the interface directly to allow for future interface changes.
Field Summary | |
---|---|
protected java.util.List<SearchCategory> |
_allSearchableCategories
All categories that can be searched upon, not necessarily the ones the user picked to search on. |
protected java.util.List<TreeItem> |
_attributeTreeItems
The root tree items wrapped by _attributeTreeModel for our JSF tree. |
protected org.apache.myfaces.trinidad.model.TreeModel |
_attributeTreeModel
|
protected java.lang.String |
_callerContext
|
protected java.util.List<BaseTreeItem> |
_commonTreeItems
The root tree items wrapped by _commonTreeModel for our common filters JSF tree. |
protected org.apache.myfaces.trinidad.model.TreeModel |
_commonTreeModel
|
protected java.lang.String |
_errorMessageName
Error message name in cases where _inError == true. |
protected boolean |
_inError
|
protected java.util.Locale |
_locale
Locale to do formatting on. |
protected java.util.List<AdvancedSearchAttribute> |
_orderingAttributes
The set of attribute names we can order by. |
protected boolean |
_rtl
Is this result in Right-to-Left order. |
protected boolean |
_searched
Has this search been performed? |
protected java.util.List<SearchCategory> |
_searchedCategories
The basic set of searched categories selected by the user from the Category list in the UI. |
protected boolean |
_searchExhausted
Has the search been exhausted, that is all results retrieved and in memory? |
protected SearchFilterItems |
_searchFilterItems
|
protected java.lang.String |
_searchString
|
Fields inherited from interface oracle.apps.fnd.applcore.globalSearch.ui.SearchResult |
---|
BACKGROUND_SEARCH_BLOCK_SIZE, BACKGROUND_SEARCH_MAX_POLL_COUNT, BACKGROUND_SEARCH_POLL_INTERVAL, BLOCK_SIZE, LAST_UPDATED_DATE_ORDER_ATTRIBUTE, RELEVANCE_ORDER_ATTRIBUTE |
Constructor Summary | |
---|---|
AbstractSearchResult(AbstractSearchResult base,
java.lang.String searchTabName,
java.util.List<SearchCategory> searchCategories,
java.util.List<SearchCategory> allSearchableCategories,
java.lang.String searchString,
java.lang.String callerContext,
boolean usesFilters)
Construct this class. |
|
AbstractSearchResult(java.lang.String searchTabName,
java.util.List<SearchCategory> searchCategories,
java.util.List<SearchCategory> allSearchableCategories,
java.lang.String searchString,
java.lang.String callerContext,
boolean usesFilters)
Construct this class. |
Method Summary | |
---|---|
void |
addAlternateWords(java.lang.String alternateWords)
Set the alternate words from a csv String. |
void |
addWarning(java.lang.String warning)
Add a warning to the search result. |
void |
backgroundSearch(GlobalSearchSessionBean gssb)
Run a background search given the existing set of criteria, that is categories, search string and filters. |
boolean |
containsAllSearchableCategories(java.util.List<SearchCategory> categories)
Does the passed list of categories contain all of the Searchable categories. |
boolean |
equals(java.lang.Object obj)
|
void |
generatePersistentFilters(java.util.List<PersistentSearchFilter> searchFilters,
java.util.List<SearchCategory> allCats)
Add persistent filters into the searchFilters arguement from the current search result. |
java.util.List<SearchCategory> |
getAllSearchableCategories()
Get the list of all allowed categories the user can pick from. |
java.util.List<java.lang.String> |
getAlternateWords()
Get the alternate words for this search. |
java.lang.String |
getApproxNumResultsStr()
Get the heuristic number of results the searh engine estimates it can return as a String "1234 Resuts". |
java.util.List<TreeItem> |
getAttributeTreeItems()
Get the attribute tree items for this search. |
org.apache.myfaces.trinidad.model.TreeModel |
getAttributeTreeModel()
Get the attribute Tree Model. |
java.lang.String |
getCallerContext()
Get the caller Search Context for this Search. |
java.util.List<SearchCategory> |
getCategoriesUsedInSearchQuery()
Get the categories actually used in the search query, this is not necessarily _searchCategories, in cases where a narrowing of the query is done using filters. |
TreeItem |
getCategoryTreeItem(SearchCategory cat)
Get the root level Tree Item for given category. |
org.apache.myfaces.trinidad.model.RowKeySet |
getCommonTreeDisclosedRowKeys()
Get the disclosed row keys for the Common filters tree. |
java.util.List<BaseTreeItem> |
getCommonTreeItems()
Get the common tree items for this search. |
org.apache.myfaces.trinidad.model.TreeModel |
getCommonTreeModel()
Get the common Tree Model. |
int |
getCurrentNumberOfResults()
Get the current number of group results. |
org.apache.myfaces.trinidad.model.RowKeySet |
getDisclosedRowKeys()
Get the disclosed row keys for this result. |
java.lang.String |
getErrorMessageName()
Obtain an error message name for the search, for cases where isInError() == true. |
SearchResultItem |
getItem(int index)
Get the search results result item at index i. |
org.apache.myfaces.trinidad.model.CollectionModel |
getItemsCM()
Get the CollectionModel used by the UI to show the results. |
java.util.Locale |
getLocale()
Get the Locale for this result. |
java.lang.String |
getOrderingAttribute()
Get the ordering attribute for this result. |
java.util.List<AdvancedSearchAttribute> |
getOrderingAttributes()
Get Attribute names for those attributes currently returned by the search result. |
java.util.List<SearchResultItem> |
getResultItems()
Get the result items. |
long |
getSearchCreationTime()
Get the time this class was created. |
java.util.List<SearchCategory> |
getSearchedCategories()
Get the list of categories used in the search. |
SearchFilterItems |
getSearchFilterItems()
Get the current Search FIlter Items, this will include the categories, search text, topic and attribute filters. |
java.lang.String |
getSearchString()
Get the Search String as entered by the user. |
java.lang.String |
getSearchTabName()
Get the search tab name. |
java.util.List<java.lang.String> |
getWarningsList()
Get any warnings from the search result. |
int |
hashCode()
|
boolean |
isBackgroundSearched()
Has a background search been performed? |
boolean |
isBackgroundSearchPollCountExceeded()
Has the background poll count been exceeded? This method will prevent infinite polls (even though this is unlikely as search engine should exception after some period, even in worst case scnarios), even after the results window has been removed. |
boolean |
isInError()
Is this search in error, that is could not be performed and should not be shown. |
boolean |
isOrderingAsc()
Is the order ascending? |
boolean |
isRtl()
Get the reading direction for this result. |
boolean |
isSaved()
Was this search result originally a saved search? It may have been refreshed due to an attribute filter re-search, but this would not change the fact that it was originally run as a seved search. |
boolean |
isSearched()
Has the search been performed? |
boolean |
isSearchExhausted()
Has the search been exhausted, that is all results retrieved and in memory? |
boolean |
isUsesFilters()
Does this Search result support Attribute Filters? |
boolean |
isWarnings()
Are there any warnings to show the user? |
void |
onBackgroundSearchPoll()
Method to call when a background search poll is performed. |
void |
reOrder()
Sort the results, based on current sort algorith, if any. |
void |
setBackgroundSearched(boolean backgroundSearched)
Set the a background search status? |
void |
setDisclosedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet disclosedRowKeys)
Set the disclosed row keys for this result. |
void |
setOrderingAsc(boolean orderingAsc)
Set the ordering direction for this result. |
void |
setOrderingAttribute(java.lang.String attr)
Set the ordering attribute for this result. |
void |
setSaved(boolean wasSaved)
Set the initial saved stateof this search? It may have been refreshed due to an attribute filter re-search, but this would not change the fact that it was originally run as a seved search. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface oracle.apps.fnd.applcore.globalSearch.ui.SearchResult |
---|
allResultsRetrieved, copySearch, extendSearchResults, getApproxNumResults, search |
Field Detail |
---|
protected boolean _searched
protected boolean _searchExhausted
protected boolean _inError
protected java.lang.String _errorMessageName
protected SearchFilterItems _searchFilterItems
protected java.util.List<SearchCategory> _searchedCategories
protected java.util.List<SearchCategory> _allSearchableCategories
protected java.lang.String _searchString
protected java.lang.String _callerContext
protected java.util.List<TreeItem> _attributeTreeItems
protected transient org.apache.myfaces.trinidad.model.TreeModel _attributeTreeModel
protected java.util.List<BaseTreeItem> _commonTreeItems
protected transient org.apache.myfaces.trinidad.model.TreeModel _commonTreeModel
protected boolean _rtl
protected java.util.Locale _locale
protected java.util.List<AdvancedSearchAttribute> _orderingAttributes
Constructor Detail |
---|
public AbstractSearchResult(java.lang.String searchTabName, java.util.List<SearchCategory> searchCategories, java.util.List<SearchCategory> allSearchableCategories, java.lang.String searchString, java.lang.String callerContext, boolean usesFilters)
searchTabName
- Search Tab name.searchCategories
- search categories.allSearchableCategories
- list of allowed categories to search on.
A superset of searchCategories.searchString
- Search String.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.usesFilters
- does this search use filters.public AbstractSearchResult(AbstractSearchResult base, java.lang.String searchTabName, java.util.List<SearchCategory> searchCategories, java.util.List<SearchCategory> allSearchableCategories, java.lang.String searchString, java.lang.String callerContext, boolean usesFilters)
base
- base search to take items from.searchTabName
- Search Tab name.searchCategories
- search categories.allSearchableCategories
- list of allowed categories to search on.
A superset of searchCategories.searchString
- Search String.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.usesFilters
- does this search use filters.Method Detail |
---|
public SearchFilterItems getSearchFilterItems()
getSearchFilterItems
in interface SearchResult
public java.util.List<SearchCategory> getSearchedCategories()
getSearchedCategories
in interface SearchResult
public java.util.List<SearchCategory> getAllSearchableCategories()
getAllSearchableCategories
in interface SearchResult
public boolean containsAllSearchableCategories(java.util.List<SearchCategory> categories)
containsAllSearchableCategories
in interface SearchResult
categories
- non-null List of SearchCategory.
public java.lang.String getSearchString()
getSearchString
in interface SearchResult
public java.lang.String getCallerContext()
getCallerContext
in interface SearchResult
public org.apache.myfaces.trinidad.model.TreeModel getAttributeTreeModel()
getAttributeTreeModel
in interface SearchResult
public TreeItem getCategoryTreeItem(SearchCategory cat)
getCategoryTreeItem
in interface SearchResult
cat
- group to find.
public org.apache.myfaces.trinidad.model.CollectionModel getItemsCM()
getItemsCM
in interface SearchResult
public java.util.List<TreeItem> getAttributeTreeItems()
getAttributeTreeItems
in interface SearchResult
public java.util.List<BaseTreeItem> getCommonTreeItems()
getCommonTreeItems
in interface SearchResult
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String getSearchTabName()
getSearchTabName
in interface SearchResult
public boolean isSearched()
isSearched
in interface SearchResult
public boolean isSearchExhausted()
isSearchExhausted
in interface SearchResult
public boolean isUsesFilters()
isUsesFilters
in interface SearchResult
public void setDisclosedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet disclosedRowKeys)
setDisclosedRowKeys
in interface SearchResult
disclosedRowKeys
- disclosed row keys.public org.apache.myfaces.trinidad.model.RowKeySet getDisclosedRowKeys()
getDisclosedRowKeys
in interface SearchResult
public boolean isSaved()
isSaved
in interface SearchResult
public void setSaved(boolean wasSaved)
setSaved
in interface SearchResult
wasSaved
- if was originally run as a saved search, false otherwise.public long getSearchCreationTime()
getSearchCreationTime
in interface SearchResult
public java.lang.String getApproxNumResultsStr()
getApproxNumResultsStr
in interface SearchResult
SearchResult.getApproxNumResults()
public boolean isInError()
isInError
in interface SearchResult
public java.lang.String getErrorMessageName()
getErrorMessageName
in interface SearchResult
public java.util.List<java.lang.String> getWarningsList()
getWarningsList
in interface SearchResult
public void addWarning(java.lang.String warning)
addWarning
in interface SearchResult
warning
- the warning text to show the user.public boolean isWarnings()
isWarnings
in interface SearchResult
public void addAlternateWords(java.lang.String alternateWords)
alternateWords
- csv string of alternate words.public boolean isRtl()
public java.util.Locale getLocale()
public java.util.List<java.lang.String> getAlternateWords()
getAlternateWords
in interface SearchResult
public int getCurrentNumberOfResults()
getCurrentNumberOfResults
in interface SearchResult
public java.util.List<SearchResultItem> getResultItems()
getResultItems
in interface SearchResult
public SearchResultItem getItem(int index)
getItem
in interface SearchResult
index
- 0 based index into results.
public java.util.List<SearchCategory> getCategoriesUsedInSearchQuery()
public boolean isBackgroundSearched()
isBackgroundSearched
in interface SearchResult
public void setBackgroundSearched(boolean backgroundSearched)
setBackgroundSearched
in interface SearchResult
backgroundSearched
- true if a background search has been performed,
false otherwise.public void backgroundSearch(GlobalSearchSessionBean gssb)
backgroundSearch
in interface SearchResult
gssb
- session bean, not available from session in new thread.public java.util.List<AdvancedSearchAttribute> getOrderingAttributes()
getOrderingAttributes
in interface SearchResult
public void setOrderingAsc(boolean orderingAsc)
setOrderingAsc
in interface SearchResult
orderingAsc
- true for ascending, false for descending.public boolean isOrderingAsc()
isOrderingAsc
in interface SearchResult
public void setOrderingAttribute(java.lang.String attr)
setOrderingAttribute
in interface SearchResult
attr
- name of attribute.public java.lang.String getOrderingAttribute()
getOrderingAttribute
in interface SearchResult
public void reOrder()
reOrder
in interface SearchResult
public org.apache.myfaces.trinidad.model.TreeModel getCommonTreeModel()
getCommonTreeModel
in interface SearchResult
public org.apache.myfaces.trinidad.model.RowKeySet getCommonTreeDisclosedRowKeys()
getCommonTreeDisclosedRowKeys
in interface SearchResult
public void onBackgroundSearchPoll()
onBackgroundSearchPoll
in interface SearchResult
public boolean isBackgroundSearchPollCountExceeded()
isBackgroundSearchPollCountExceeded
in interface SearchResult
public void generatePersistentFilters(java.util.List<PersistentSearchFilter> searchFilters, java.util.List<SearchCategory> allCats)
searchFilters
- filters list to fill.allCats
- all possible categories.
|
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 |