|
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.AbstractSearchResult oracle.apps.fnd.applcore.globalSearch.ui.ecsf.ECSFSearchResultAdapter
public class ECSFSearchResultAdapter
ECSF specific Search Results.
Field Summary |
---|
Fields inherited from class oracle.apps.fnd.applcore.globalSearch.ui.AbstractSearchResult |
---|
_allSearchableCategories, _attributeTreeItems, _attributeTreeModel, _callerContext, _commonTreeItems, _commonTreeModel, _errorMessageName, _inError, _locale, _orderingAttributes, _rtl, _searched, _searchedCategories, _searchExhausted, _searchFilterItems, _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 | |
---|---|
ECSFSearchResultAdapter(AbstractSearchResult base)
Copy constructor that will duplicate the search structure, but not do a search. |
|
ECSFSearchResultAdapter(ECSFRecentSearch rs,
java.lang.String searchTabName,
java.util.List<SearchCategory> searchCategories,
java.util.List<SearchCategory> allSearchableCategories,
java.lang.String searchString,
java.lang.String callerContext,
boolean performInitialSearch,
boolean usesFilters)
Run a recent Search. |
|
ECSFSearchResultAdapter(ECSFSavedSearch ss,
java.lang.String searchTabName,
java.util.List<SearchCategory> searchCategories,
java.util.List<SearchCategory> allSearchableCategories,
java.lang.String searchString,
java.lang.String callerContext,
boolean performInitialSearch,
boolean usesFilters)
Run a saved Search. |
|
ECSFSearchResultAdapter(java.lang.String searchTabName,
java.util.List<SearchCategory> searchCategories,
java.util.List<SearchCategory> allSearchableCategories,
java.lang.String searchString,
java.lang.String callerContext,
boolean performInitialSearch,
boolean usesFilters)
Run a brand new Search. |
Method Summary | |
---|---|
static void |
addBIItem(oracle.ecsf.SearchContext context,
java.util.List<SearchResultItem> resultItems,
java.util.Map<java.lang.String,java.lang.Object> fields,
oracle.ecsf.IndexedDocument ecsfDocument,
ECSFSearchResultAdapter sra)
add a Business Intelligence result item. |
static void |
addItem(oracle.ecsf.SearchContext searchContext,
java.util.List<SearchResultItem> resultItems,
oracle.ecsf.IndexedDocument ecsfDocument,
ECSFSearchResultAdapter sra)
Add ecsfDocument to the result list. |
static void |
addWCItem(oracle.ecsf.SearchContext context,
java.util.List<SearchResultItem> resultItems,
java.util.Map<java.lang.String,java.lang.Object> fields,
oracle.ecsf.IndexedDocument ecsfDocument,
ECSFSearchResultAdapter sra)
Add a Web Center Item. |
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. |
SearchResult |
copySearch()
Copy the search criteria, but do not perform a search. |
boolean |
equals(java.lang.Object obj)
|
boolean |
extendSearchResults()
Extend the search results. |
int |
getApproxNumResults()
Get the heuristic number of results the searh engine estimates it can return. |
org.apache.myfaces.trinidad.model.TreeModel |
getAttributeTreeModel()
Get the attribute Tree Model. |
static java.lang.String |
getPreferencesURLParams()
Returns an ampersand delimited string which contains ApplSession preferences name value pairs. |
int |
hashCode()
|
void |
search()
Run a search given the existing set of criteria, that is categories, search string and filters. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ECSFSearchResultAdapter(java.lang.String searchTabName, java.util.List<SearchCategory> searchCategories, java.util.List<SearchCategory> allSearchableCategories, java.lang.String searchString, java.lang.String callerContext, boolean performInitialSearch, boolean usesFilters)
searchTabName
- Search Tab name.searchCategories
- user selected categories.allSearchableCategories
- list of allowed categories to search on.
A superset of searchCategories.searchString
- user entered 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.performInitialSearch
- do we perform an initial search.usesFilters
- does this search use filters.public ECSFSearchResultAdapter(ECSFSavedSearch ss, java.lang.String searchTabName, java.util.List<SearchCategory> searchCategories, java.util.List<SearchCategory> allSearchableCategories, java.lang.String searchString, java.lang.String callerContext, boolean performInitialSearch, boolean usesFilters)
ss
- the search to run.searchTabName
- name of tab to go in.searchCategories
- categories to search.allSearchableCategories
- all possible categories.searchString
- user-entered search String.callerContext
- caller context - global or user-defined.performInitialSearch
- do we do the search inline with this call, or
will a separate search() all be required?usesFilters
- does this saved search use filters.public ECSFSearchResultAdapter(ECSFRecentSearch rs, java.lang.String searchTabName, java.util.List<SearchCategory> searchCategories, java.util.List<SearchCategory> allSearchableCategories, java.lang.String searchString, java.lang.String callerContext, boolean performInitialSearch, boolean usesFilters)
rs
- the search to run.searchTabName
- name of tab to go in.searchCategories
- categories to search.allSearchableCategories
- all possible categories.searchString
- user-entered search String.callerContext
- caller context - global or user-defined.performInitialSearch
- do we do the search inline with this call, or
will a separate search() all be required?usesFilters
- does this saved search use filters.public ECSFSearchResultAdapter(AbstractSearchResult base)
base
- search to copy.Method Detail |
---|
public SearchResult copySearch()
copySearch
in interface SearchResult
public void search()
search
in interface SearchResult
public static void addItem(oracle.ecsf.SearchContext searchContext, java.util.List<SearchResultItem> resultItems, oracle.ecsf.IndexedDocument ecsfDocument, ECSFSearchResultAdapter sra)
searchContext
- ecsf search context.resultItems
- array of items to add to.ecsfDocument
- search result document.sra
- contining search result class.public static void addBIItem(oracle.ecsf.SearchContext context, java.util.List<SearchResultItem> resultItems, java.util.Map<java.lang.String,java.lang.Object> fields, oracle.ecsf.IndexedDocument ecsfDocument, ECSFSearchResultAdapter sra)
context
- Search context.resultItems
- to add to.fields
- search attributes.ecsfDocument
- the indexed documentsra
- this search result.public static void addWCItem(oracle.ecsf.SearchContext context, java.util.List<SearchResultItem> resultItems, java.util.Map<java.lang.String,java.lang.Object> fields, oracle.ecsf.IndexedDocument ecsfDocument, ECSFSearchResultAdapter sra)
context
- search context.resultItems
- collection to add result to.fields
- fields from SES.ecsfDocument
- doc.sra
- current search result adapter, primarily for adding counts to.public static java.lang.String getPreferencesURLParams()
public boolean extendSearchResults()
extendSearchResults
in interface SearchResult
public boolean allResultsRetrieved()
allResultsRetrieved
in interface SearchResult
public int getApproxNumResults()
getApproxNumResults
in interface SearchResult
public org.apache.myfaces.trinidad.model.TreeModel getAttributeTreeModel()
getAttributeTreeModel
in interface SearchResult
getAttributeTreeModel
in class AbstractSearchResult
public void backgroundSearch(GlobalSearchSessionBean gssb)
backgroundSearch
in interface SearchResult
backgroundSearch
in class AbstractSearchResult
gssb
- search session bean, passed as not available from session in
separate thread.public boolean equals(java.lang.Object obj)
equals
in class AbstractSearchResult
public int hashCode()
hashCode
in class AbstractSearchResult
|
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 |