oracle.ecsf.client
Class SearchCtrl

java.lang.Object
  oracle.ecsf.client.SearchCtrl

All Implemented Interfaces:

java.io.Serializable

public class SearchCtrl
extends java.lang.Object
implements java.io.Serializable

This class is the entry point to ECSF query related functionalitiess such retrieving search groups as well as performing basic and advanced searches.

See Also:

Serialized Form

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

CLASS_PREFIX

public static final java.lang.String CLASS_PREFIX

See Also:

Constant Field Values

Constructor Detail

SearchCtrl

public SearchCtrl()

Initializes the MetaDataManager

Throws:

SearchException - if MetaDataManager initialized fails

Method Detail

getEngineInstances

public java.util.Collection<SearchEngineInstance> getEngineInstances()

Returns a list of search engine instances from current ECSF installation.

Returns:

list of search engine instances.

getSearchGroups

public java.util.Collection<SearchGroup> getSearchGroups()

Gets the available search groups for basic search

Returns:

Collection of SearchGroups

getSearchGroup

public 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

Parameters:

engineInstanceName - name of engine instances

groupName - name of the group

Returns:

SearchGroup

getSearchGroups

public java.util.Collection<SearchGroup> getSearchGroups(java.lang.String engineInstanceName)

Gets the available search groups for basic search based on engine instance name

Parameters:

engineInstanceName -

Returns:

Collection of SearchGroups

getSearchGroups

public java.util.Collection<SearchGroup> getSearchGroups(long engineInstanceId)

Gets the available search groups for basic search based on engine instance id

Parameters:

engineInstanceId -

Returns:

Collection of SearchGroups

getAdvancedSearchGroups

public java.util.Collection<SearchGroup> getAdvancedSearchGroups(java.lang.String engineInstanceName)

Gets the available search groups for advanced search based on engine instance name

Parameters:

engineInstanceName -

Returns:

Collection of SearchGroups

getAdvancedSearchGroups

public java.util.Collection<SearchGroup> getAdvancedSearchGroups(long engineInstanceId)

Gets the available search groups for advanced search based on engine instance id

Parameters:

engineInstanceId -

Returns:

Collection of SearchGroups

getOperators

public java.lang.String[] getOperators(java.lang.String dataType)

Gets the operators for a particular data type, used for advanced search

Parameters:

dataType - data type

Returns:

String[] operators

runQuery

public SearchHits runQuery(QueryMetaData queryMetaData)
                    throws SearchException

Performs the search using query metadata, a new search context will be created

Parameters:

queryMetaData -

Returns:

SearchHits object

Throws:

SearchException

runQuery

public SearchHits runQuery(SearchContext searchContext,
                           QueryMetaData queryMetaData)
                    throws SearchException

Performs the search using search context and query metadata

Parameters:

searchContext -

queryMetaData -

Returns:

SearchHits object

Throws:

SearchException

runSavedSearch

public SearchHits runSavedSearch(SearchContext searchContext,
                                 java.lang.String savedSearchName)
                          throws SearchException

Deprecated. Retrieves and performs the specified saved search

Parameters:

searchContext -

savedSearchName - SavedSearch name

Returns:

SearchHits object

Throws:

SearchException

runSavedSearch

public SearchHits runSavedSearch(SearchContext searchContext,
                                 SavedSearch savedSearch)
                          throws SearchException

Executes a saved search using search context and saved search object

Parameters:

searchContext -

savedSearch - SavedSearch object

Returns:

SearchHits object

Throws:

SearchException

runRecentSearch

public SearchHits runRecentSearch(SearchContext searchContext,
                                  RecentSearch recentSearch)
                           throws SearchException

Executes a recent search using search context and recent search object

Parameters:

searchContext -

recentSearch - recentSearch object

Returns:

SearchHits object

Throws:

SearchException

getSession

public SessionObject getSession(SearchContext ctx)

Gets the active session from the search context for reuse

Parameters:

ctx -

Returns:

SessionObject session

bindSession

public void bindSession(SearchContext ctx,
                        SessionObject session)

Binds an existing session to the current SearchContext

Parameters:

ctx -

session -

endSession

public boolean endSession(SessionObject session)

Deprecated. Ends the current session which logs out of the SES proxy.

Parameters:

session -

Throws:

SearchException - if proxy logout fails