|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SearchClient
ATG Search client. Entrypoint for client searches.
Field Summary | |
---|---|
static java.lang.String |
APPSERVER_TYPE
property name for the type of appserver/server connection (rmi or local) |
static java.lang.String |
CLASS_VERSION
Class version string |
static java.lang.String |
HOSTNAME
property name for the server's hostname; only for rmi |
static java.lang.String |
PORT
property name for the host's rmi port; only for rmi |
static java.lang.String |
RMI_COMPONENT_PATH
property name for the host's rmi component path; only for rmi |
Method Summary | |
---|---|
atg.search.client.SearchSession |
beginSession()
Begins the user search session. |
void |
cancelBulkIndexing(java.lang.String pEnvironmentName)
|
void |
finishBulkIndexing(java.lang.String pEnvironmentName)
|
java.util.Collection |
getSearchEnvironmentTargets()
|
atg.search.events.SearchMessageTools |
getSearchMessageService()
|
atg.search.routing.command.SearchEngineCommandResponse |
index(atg.search.routing.command.indexing.IndexingRequest request,
java.lang.String indexingEnvironmentName,
java.lang.String logicalPartitionName)
|
boolean |
isFiringSearchEvents()
|
boolean |
isLiveIndexingSupported(java.lang.String pEnvironmentName)
Indicates whether live indexing is supported for the environment. |
boolean |
isLiveSearchingSupported(java.lang.String pEnvironmentName)
Indicates whether live searching is supported for the environment. |
java.lang.String |
prepareBulkIndexing(java.lang.String pEnvironmentName)
Starts the bulk indexing process for live indexing environments, and returns the name of the search environment that must be used for bulk indexing. |
void |
reset()
Resets the client's connection. |
BrowseRequest.Response |
search(BrowseRequest request,
atg.search.client.SearchSession searchSession)
Submits a BrowseRequest and returns a BrowseRequest.Response. |
CategorizeRequest.Response |
search(CategorizeRequest request,
atg.search.client.SearchSession searchSession)
Submits a CategorizeRequest and returns a CategorizeRequest.Response. |
QueryRequest.Response |
search(QueryRequest request,
atg.search.client.SearchSession searchSession)
Submits a QueryRequest and returns a QueryRequest.Response. |
SearchResponse |
search(SearchRequest request,
atg.search.client.SearchSession searchSession)
Catch-all method for searching with SearchRequest-derived types as SearchRequests. |
SimilarDocsRequest.Response |
search(SimilarDocsRequest request,
atg.search.client.SearchSession searchSession)
Submits a SimilarDocsRequest and returns a SimilarDocsRequest.Response. |
StructuredQueryRequest.Response |
search(StructuredQueryRequest request,
atg.search.client.SearchSession searchSession)
Submits a StructuredQueryRequest and returns a StructuredQueryRequest.Response. |
TreeQueryRequest.Response |
search(TreeQueryRequest request,
atg.search.client.SearchSession searchSession)
Submits a TreeQueryRequest and returns a TreeQueryRequest.Response. |
TypeAheadRequest.Response |
search(TypeAheadRequest request,
atg.search.client.SearchSession searchSession)
Submits a TypeAheadRequest and returns a TypeAheadRequest.Response. |
ViewDocumentRequest.Response |
search(ViewDocumentRequest request,
atg.search.client.SearchSession searchSession)
Submits a ViewDocumentRequest and returns a ViewDocumentRequest.Response. |
void |
setFiringSearchEvents(boolean pFiringSearchEvents)
Enables or disables firing of search events |
void |
setLiveIndexingSupported(java.lang.String pEnvironmentName,
boolean pIsLiveIndexingSupported)
Sets whether live indexing is supported for the given environment. |
void |
setLiveSearchingSupported(java.lang.String pEnvironmentName,
boolean pIsLiveSearchingSupported)
Sets whether live searching is supported for the given live indexing environment. |
void |
setSearchMessageService(atg.search.events.SearchMessageTools pSearchMessageService)
|
Field Detail |
---|
static final java.lang.String CLASS_VERSION
static final java.lang.String APPSERVER_TYPE
static final java.lang.String HOSTNAME
static final java.lang.String PORT
static final java.lang.String RMI_COMPONENT_PATH
Method Detail |
---|
void reset()
java.util.Collection getSearchEnvironmentTargets() throws atg.search.client.SearchClientException
SearchEnvironmentTarget
atg.search.client.SearchClientException
boolean isFiringSearchEvents() throws atg.search.client.SearchClientException
atg.search.client.SearchClientException
void setFiringSearchEvents(boolean pFiringSearchEvents) throws atg.search.client.SearchClientException
pFiringSearchEvents
- true if search events should be fired
atg.search.client.SearchClientException
atg.search.client.SearchSession beginSession() throws atg.search.client.SearchClientException
SearchClientException
- that wraps any application server related exceptionsSearchResponse search(SearchRequest request, atg.search.client.SearchSession searchSession) throws atg.search.client.SearchClientException
request
- searchSession
-
atg.search.client.SearchClientException
QueryRequest.Response search(QueryRequest request, atg.search.client.SearchSession searchSession) throws atg.search.client.SearchClientException
request
- the query requestsearchSession
- active search session
atg.search.client.SearchClientException
TreeQueryRequest.Response search(TreeQueryRequest request, atg.search.client.SearchSession searchSession) throws atg.search.client.SearchClientException
request
- the query requestsearchSession
- active search session
atg.search.client.SearchClientException
TypeAheadRequest.Response search(TypeAheadRequest request, atg.search.client.SearchSession searchSession) throws atg.search.client.SearchClientException
request
- the query requestsearchSession
- active search session
atg.search.client.SearchClientException
BrowseRequest.Response search(BrowseRequest request, atg.search.client.SearchSession searchSession) throws atg.search.client.SearchClientException
request
- the BrowseRequest requestsearchSession
- active search session
atg.search.client.SearchClientException
CategorizeRequest.Response search(CategorizeRequest request, atg.search.client.SearchSession searchSession) throws atg.search.client.SearchClientException
request
- the CategorizeRequest requestsearchSession
- active search session
atg.search.client.SearchClientException
StructuredQueryRequest.Response search(StructuredQueryRequest request, atg.search.client.SearchSession searchSession) throws atg.search.client.SearchClientException
request
- the StructuredQueryRequest requestsearchSession
- active search session
atg.search.client.SearchClientException
ViewDocumentRequest.Response search(ViewDocumentRequest request, atg.search.client.SearchSession searchSession) throws atg.search.client.SearchClientException
request
- the ViewDocumentRequest requestsearchSession
- active search session
atg.search.client.SearchClientException
SimilarDocsRequest.Response search(SimilarDocsRequest request, atg.search.client.SearchSession searchSession) throws atg.search.client.SearchClientException
request
- the SimilarDocsRequest requestsearchSession
- active search session
atg.search.client.SearchClientException
atg.search.events.SearchMessageTools getSearchMessageService() throws atg.search.client.SearchClientException
atg.search.client.SearchClientException
void setSearchMessageService(atg.search.events.SearchMessageTools pSearchMessageService) throws atg.search.client.SearchClientException
atg.search.client.SearchClientException
boolean isLiveIndexingSupported(java.lang.String pEnvironmentName) throws atg.search.client.SearchClientException
pEnvironmentName
-
SearchClientException
void setLiveIndexingSupported(java.lang.String pEnvironmentName, boolean pIsLiveIndexingSupported) throws atg.search.client.SearchClientException
pEnvironmentName
- pIsLiveIndexingSupported
-
SearchClientException
boolean isLiveSearchingSupported(java.lang.String pEnvironmentName) throws atg.search.client.SearchClientException
pEnvironmentName
-
SearchClientException
void setLiveSearchingSupported(java.lang.String pEnvironmentName, boolean pIsLiveSearchingSupported) throws atg.search.client.SearchClientException
pEnvironmentName
- pIsLiveSearchingSupported
-
SearchClientException
java.lang.String prepareBulkIndexing(java.lang.String pEnvironmentName) throws atg.search.client.SearchClientException
pEnvironmentName
-
SearchClientException
void cancelBulkIndexing(java.lang.String pEnvironmentName) throws atg.search.client.SearchClientException
atg.search.client.SearchClientException
void finishBulkIndexing(java.lang.String pEnvironmentName) throws atg.search.client.SearchClientException
atg.search.client.SearchClientException
atg.search.routing.command.SearchEngineCommandResponse index(atg.search.routing.command.indexing.IndexingRequest request, java.lang.String indexingEnvironmentName, java.lang.String logicalPartitionName) throws atg.search.client.SearchClientException
atg.search.client.SearchClientException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |