|
Oracle Fusion Applications Search Java API Reference for Oracle Enterprise Crawl and Search Framework
11g Release 1 (11.1.1.6) E21908-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.ecsf.client.SearchCtrl
public class SearchCtrl
This class is the entry point to ECSF query related functionalitiess such retrieving search groups as well as performing basic and advanced searches.
Field Summary | |
---|---|
static java.lang.String |
CLASS_PREFIX
|
Constructor Summary | |
---|---|
SearchCtrl()
Initializes the MetaDataManager |
Method Summary | |
---|---|
void |
bindSession(SearchContext ctx,
SessionObject session)
Binds an existing session to the current SearchContext |
boolean |
endSession(SessionObject session)
Deprecated. Ends the current session which logs out of the SES proxy. |
java.util.Collection<SearchGroup> |
getAdvancedSearchGroups(long engineInstanceId)
Gets the available search groups for advanced search based on engine instance id |
java.util.Collection<SearchGroup> |
getAdvancedSearchGroups(java.lang.String engineInstanceName)
Gets the available search groups for advanced search based on engine instance name |
java.util.Collection<SearchEngineInstance> |
getEngineInstances()
Returns a list of search engine instances from current ECSF installation. |
java.lang.String[] |
getOperators(java.lang.String dataType)
Gets the operators for a particular data type, used for advanced search |
SearchGroup |
getSearchGroup(java.lang.String engineInstanceName,
java.lang.String groupName)
Gets a search group for basic search based on engine instance name and search group name |
java.util.Collection<SearchGroup> |
getSearchGroups()
Gets the available search groups for basic search |
java.util.Collection<SearchGroup> |
getSearchGroups(long engineInstanceId)
Gets the available search groups for basic search based on engine instance id |
java.util.Collection<SearchGroup> |
getSearchGroups(java.lang.String engineInstanceName)
Gets the available search groups for basic search based on engine instance name |
SessionObject |
getSession(SearchContext ctx)
Gets the active session from the search context for reuse |
SearchHits |
runQuery(QueryMetaData queryMetaData)
Performs the search using query metadata, a new search context will be created |
SearchHits |
runQuery(SearchContext searchContext,
QueryMetaData queryMetaData)
Performs the search using search context and query metadata |
SearchHits |
runRecentSearch(SearchContext searchContext,
RecentSearch recentSearch)
Executes a recent search using search context and recent search object |
SearchHits |
runSavedSearch(SearchContext searchContext,
SavedSearch savedSearch)
Executes a saved search using search context and saved search object |
SearchHits |
runSavedSearch(SearchContext searchContext,
java.lang.String savedSearchName)
Deprecated. Retrieves and performs the specified saved search |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CLASS_PREFIX
Constructor Detail |
---|
public SearchCtrl()
SearchException
- if MetaDataManager initialized failsMethod Detail |
---|
public java.util.Collection<SearchEngineInstance> getEngineInstances()
public java.util.Collection<SearchGroup> getSearchGroups()
public SearchGroup getSearchGroup(java.lang.String engineInstanceName, java.lang.String groupName)
engineInstanceName
- name of engine instancesgroupName
- name of the group
public java.util.Collection<SearchGroup> getSearchGroups(java.lang.String engineInstanceName)
engineInstanceName
-
public java.util.Collection<SearchGroup> getSearchGroups(long engineInstanceId)
engineInstanceId
-
public java.util.Collection<SearchGroup> getAdvancedSearchGroups(java.lang.String engineInstanceName)
engineInstanceName
-
public java.util.Collection<SearchGroup> getAdvancedSearchGroups(long engineInstanceId)
engineInstanceId
-
public java.lang.String[] getOperators(java.lang.String dataType)
dataType
- data type
public SearchHits runQuery(QueryMetaData queryMetaData) throws SearchException
queryMetaData
-
SearchException
public SearchHits runQuery(SearchContext searchContext, QueryMetaData queryMetaData) throws SearchException
searchContext
- queryMetaData
-
SearchException
public SearchHits runSavedSearch(SearchContext searchContext, java.lang.String savedSearchName) throws SearchException
searchContext
- savedSearchName
- SavedSearch name
SearchException
public SearchHits runSavedSearch(SearchContext searchContext, SavedSearch savedSearch) throws SearchException
searchContext
- savedSearch
- SavedSearch object
SearchException
public SearchHits runRecentSearch(SearchContext searchContext, RecentSearch recentSearch) throws SearchException
searchContext
- recentSearch
- recentSearch object
SearchException
public SessionObject getSession(SearchContext ctx)
ctx
-
public void bindSession(SearchContext ctx, SessionObject session)
ctx
- session
- public boolean endSession(SessionObject session)
session
-
SearchException
- if proxy logout fails
|
Oracle Fusion Applications Search Java API Reference for Oracle Enterprise Crawl and Search Framework
11g Release 1 (11.1.1.6) E21908-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |