|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.5) E22562-01 |
|||||||||
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 |
BLOCK_SIZE
The number of results requested from SES via ECSF. |
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? |
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. |
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. |
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. |
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 |
isInError()
Is this search in error, that is could not be performed and should not be shown. |
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 |
isUsesFilters()
Does this Search result support Attribute Filters? |
boolean |
isWarnings()
Are there any warnings to show the user? |
void |
search()
Run a search given the existing set of criteria, that is categories, search string and filters. |
void |
setDisclosedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet disclosedRowKeys)
Set the disclosed row keys 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 ValuesMethod 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()
|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.5) E22562-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |