com.primus.ae.searchclient
Class ClientCategoryRequest

java.lang.Object
  com.primus.ae.searchclient.ClientRequestImpl
      com.primus.ae.searchclient.ClientCategoryRequest

All Implemented Interfaces:

atg.search.routing.command.SearchEngineRequest, ClientRequest, java.io.Serializable

Deprecated. as of 9.0. Use BrowseRequest instead.

public class ClientCategoryRequest
extends ClientRequestImpl

Client category browse request

See Also:

Serialized Form

Field Summary

Fields inherited from class com.primus.ae.searchclient.ClientRequestImpl

constraints, listPropertyAllowed, loggingEnabled, mLoggingThisRequest, mRequestIdentifier, mRequestTime, parsingOptions, requestAttributes

Fields inherited from interface com.primus.ae.searchclient.ClientRequest

BROWSE, CATEGORIZE, INSPECT, QUERY, REQUEST_TAG_BROWSE, REQUEST_TAG_CATEGORIZE, REQUEST_TAG_QUERY, REQUEST_TAG_SIMILARDOCS, REQUEST_TAG_STRUCTQUERY, REQUEST_TAG_VIC, SIMILARDOCS, STRUCTQUERY, TAGS, VIC

Fields inherited from interface atg.search.routing.command.SearchEngineRequest

CLASS_VERSION

Constructor Summary

ClientCategoryRequest()
Deprecated.

ClientCategoryRequest(java.lang.String queryText)
Deprecated. Simples possible category browse

ClientCategoryRequest(java.lang.String queryText, java.util.Map requestAttributes, DocumentSetConstraint constraints, ParserOptions parserOptions, boolean loggingEnabled)
Deprecated.

Method Summary

java.lang.String	getQueryText() Deprecated.
int	getRequestId() Deprecated.
void	setQueryText(java.lang.String queryText) Deprecated.
java.lang.String	toXML() Deprecated. returns xml suitable for submission to a search engine.

Methods inherited from class com.primus.ae.searchclient.ClientRequestImpl

getConstraints, getConstraintsXml, getParsingOptions, getParsingOptionsXml, getRequestAttribute, getRequestAttributes, getRequestIdentifier, getRequestTag, getRequestTime, getSearchConstraints, isFiringSearchEvents, isKeepingResponseData, isListPropertyAllowed, isLoggingEnabled, isLoggingThisRequest, processResponse, setConstraints, setFiringSearchEvents, setKeepingResponseData, setListPropertyAllowed, setLoggingEnabled, setLoggingThisRequest, setParsingOptions, setRequestAttribute, setRequestAttributes, setRequestIdentifier, setRequestTime

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientCategoryRequest

public ClientCategoryRequest()

Deprecated.

ClientCategoryRequest

public ClientCategoryRequest(java.lang.String queryText,
                             java.util.Map requestAttributes,
                             DocumentSetConstraint constraints,
                             ParserOptions parserOptions,
                             boolean loggingEnabled)

Deprecated.

Parameters:

queryText - the category to browse

requestAttributes - map of request attributes. See supporting documentation

constraints - constraint string. See supporting documentation

parserOptions - parser options

loggingEnabled - if true, request and responses are logged

See Also:

BrowseConstants

ClientCategoryRequest

public ClientCategoryRequest(java.lang.String queryText)

Deprecated.

Simples possible category browse

Parameters:

queryText - the category to browse

Method Detail

getQueryText

public java.lang.String getQueryText()

Deprecated.

Returns:

query text

setQueryText

public void setQueryText(java.lang.String queryText)

Deprecated.

Parameters:

queryText - the question

getRequestId

public int getRequestId()

Deprecated.

Returns:

ClientRequest.BROWSE

toXML

public java.lang.String toXML()
                       throws atg.search.routing.command.IncompleteCommandException

Deprecated.

returns xml suitable for submission to a search engine. In the case where this request has already been submitted, call this method to examine the submitted xml.

Returns:

request xml

Throws:

atg.search.routing.command.IncompleteCommandException - if the command is incomplete