com.primus.ae.searchclient
Class ClientCategorizeRequest

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

All Implemented Interfaces:

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

Deprecated. as of 9.0. Use CategorizeRequest instead.

public class ClientCategorizeRequest
extends ClientRequestImpl

Client query 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

ClientCategorizeRequest()
Deprecated. empty constructor

ClientCategorizeRequest(java.lang.String input)
Deprecated. simplest possible categorize request

ClientCategorizeRequest(java.lang.String input, java.util.Map requestAttributes, DocumentSetConstraint constraints, ParserOptions parserOptions)
Deprecated.

ClientCategorizeRequest(java.lang.String input, java.util.Map requestAttributes, DocumentSetConstraint constraints, ParserOptions parserOptions, boolean loggingEnabled)
Deprecated. {@see #ClientCategorizeRequest(String, Map, DocumentSetConstraint, ParserOptions) NOTE: The loggingEnabled flag no longer applies - this parameter is ignored.

Method Summary

java.lang.String	getInput() Deprecated.
int	getRequestId() Deprecated.
void	setInput(java.lang.String input) 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

ClientCategorizeRequest

public ClientCategorizeRequest()

Deprecated.

empty constructor

ClientCategorizeRequest

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

Deprecated. {@see #ClientCategorizeRequest(String, Map, DocumentSetConstraint, ParserOptions) NOTE: The loggingEnabled flag no longer applies - this parameter is ignored.

Parameters:

input - user input for which categorization is requested

requestAttributes - Map of request attributes.

constraints - document set constraints.

parserOptions - parser options xml. See supporting documentation

See Also:

CategorizeConstants

ClientCategorizeRequest

public ClientCategorizeRequest(java.lang.String input,
                               java.util.Map requestAttributes,
                               DocumentSetConstraint constraints,
                               ParserOptions parserOptions)

Deprecated.

Parameters:

input - user input for which categorization is requested

requestAttributes - Map of request attributes.

constraints - document set constraints.

parserOptions - parser options xml. See supporting documentation

See Also:

CategorizeConstants

ClientCategorizeRequest

public ClientCategorizeRequest(java.lang.String input)

Deprecated.

simplest possible categorize request

Parameters:

input - user input for which categorization is requested

Method Detail

getInput

public java.lang.String getInput()

Deprecated.

Returns:

input text

setInput

public void setInput(java.lang.String input)

Deprecated.

Parameters:

input - input text

getRequestId

public int getRequestId()

Deprecated.

Returns:

ClientRequest.CATEGORIZE

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