|
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 |
public interface SearchResult
A Search Result.
AbstractSearchResult
Field Summary | |
---|---|
static int |
BACKGROUND_SEARCH_BLOCK_SIZE
The size of a background search. |
static int |
BACKGROUND_SEARCH_MAX_POLL_COUNT
The maximum number of polls for background searches. |
static int |
BACKGROUND_SEARCH_POLL_INTERVAL
The time in milliseconds between polls for background searches. |
static int |
BLOCK_SIZE
The number of results requested from SES via ECSF. |
static java.lang.String |
LAST_UPDATED_DATE_ORDER_ATTRIBUTE
The attribute name used in a search result to "order by Last Updated Date". |
static java.lang.String |
RELEVANCE_ORDER_ATTRIBUTE
The mock attribute name used in a search result to "order by relevance". |
static long |
serialVersionUID
Serial version id for serialization. |
Method Summary | |
---|---|
void |
addWarning(java.lang.String warning)
Add a warning to the search result. |
boolean |
allResultsRetrieved()
Have all results been obtained from the search engine? |
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. |
SearchResult |
copySearch()
Copy the search criteria, but do not perform a search. |
boolean |
extendSearchResults()
Extend the search results by calling the search engine. |
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. |
int |
getApproxNumResults()
Get the heuristic number of results the searh engine estimates it can return. |
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. |
TreeItem |
getCategoryTreeItem(SearchCategory group)
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.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. |
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 |
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 |
search()
Run a search given the existing set of criteria, that is categories, search string and filters. |
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. |
Field Detail |
---|
static final int BLOCK_SIZE
SearchResultCM
,
Constant Field Valuesstatic final int BACKGROUND_SEARCH_BLOCK_SIZE
static final int BACKGROUND_SEARCH_POLL_INTERVAL
static final int BACKGROUND_SEARCH_MAX_POLL_COUNT
static final java.lang.String RELEVANCE_ORDER_ATTRIBUTE
static final java.lang.String LAST_UPDATED_DATE_ORDER_ATTRIBUTE
static final long serialVersionUID
Method Detail |
---|
long getSearchCreationTime()
SearchResult copySearch()
SearchFilterItems getSearchFilterItems()
java.util.List<SearchCategory> getSearchedCategories()
java.util.List<SearchCategory> getAllSearchableCategories()
boolean containsAllSearchableCategories(java.util.List<SearchCategory> categories)
categories
- non-null List of SearchCategory.
java.lang.String getSearchString()
java.lang.String getCallerContext()
org.apache.myfaces.trinidad.model.TreeModel getAttributeTreeModel()
TreeItem getCategoryTreeItem(SearchCategory group)
group
- group to find.
org.apache.myfaces.trinidad.model.CollectionModel getItemsCM()
int getApproxNumResults()
java.lang.String getApproxNumResultsStr()
getApproxNumResults()
int getCurrentNumberOfResults()
SearchResultItem getItem(int index)
index
- 0 based index into results.
boolean allResultsRetrieved()
boolean extendSearchResults()
boolean isSearched()
void search()
java.util.List<TreeItem> getAttributeTreeItems()
java.lang.String getSearchTabName()
boolean isUsesFilters()
void setDisclosedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet disclosedRowKeys)
disclosedRowKeys
- disclosed row keys.org.apache.myfaces.trinidad.model.RowKeySet getDisclosedRowKeys()
boolean isSaved()
void setSaved(boolean wasSaved)
wasSaved
- if was originally run as a saved search, false otherwise.boolean isInError()
java.lang.String getErrorMessageName()
java.util.List<java.lang.String> getWarningsList()
void addWarning(java.lang.String warning)
warning
- the warning text to show the user.boolean isWarnings()
java.util.List<java.lang.String> getAlternateWords()
java.util.List<SearchResultItem> getResultItems()
boolean isSearchExhausted()
boolean isBackgroundSearched()
void setBackgroundSearched(boolean backgroundSearched)
backgroundSearched
- true if a background search has been performed,
false otherwise.void backgroundSearch(GlobalSearchSessionBean gssb)
gssb
- session bean, not available from session in new thread.void onBackgroundSearchPoll()
boolean isBackgroundSearchPollCountExceeded()
java.util.List<AdvancedSearchAttribute> getOrderingAttributes()
void setOrderingAsc(boolean orderingAsc)
orderingAsc
- true for ascending, false for descending.boolean isOrderingAsc()
java.lang.String getOrderingAttribute()
void setOrderingAttribute(java.lang.String attr)
attr
- name of attribute.void reOrder()
java.util.List<BaseTreeItem> getCommonTreeItems()
org.apache.myfaces.trinidad.model.TreeModel getCommonTreeModel()
org.apache.myfaces.trinidad.model.RowKeySet getCommonTreeDisclosedRowKeys()
|
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 |