com.primus.ae.searchclient
Class ClientQueryRequest

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

All Implemented Interfaces:

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

Deprecated. as of 9.0. Use QueryRequest instead.

public class ClientQueryRequest
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

ClientQueryRequest()
Deprecated.

ClientQueryRequest(java.lang.String queryText)
Deprecated. Simplest possible query request

ClientQueryRequest(java.lang.String queryText, java.util.List priorInput, java.util.Map requestAttributes, DocumentSetConstraint constraints, DocumentSetConstraint prefAnswerConstraints, DocumentSetConstraint weightedProperties, ParserOptions parserOptions, boolean loggingEnabled)
Deprecated. Must get language for logging from parser options

ClientQueryRequest(java.lang.String queryText, java.util.List priorInput, java.util.Map requestAttributes, DocumentSetConstraint constraints, DocumentSetConstraint prefAnswerConstraints, DocumentSetConstraint weightedProperties, ParserOptions parserOptions, com.primus.searchstudio.ReportDataControl reportDataControl, com.primus.searchstudio.CustomResultRanking resultRanking, com.primus.searchstudio.CustomLogicTree logicTree, boolean loggingEnabled)
Deprecated. Must get language for logging from parser options

Method Summary

com.primus.searchstudio.CustomLogicTree	getLogicTree() Deprecated.
DocumentSetConstraint	getPrefAnswerConstraints() Deprecated.
java.lang.String	getPrefAnswerConstraintsXml() Deprecated.
java.util.List	getPriorInput() Deprecated.
java.lang.String	getQueryText() Deprecated.
com.primus.searchstudio.ReportDataControl	getReportDataControl() Deprecated.
int	getRequestId() Deprecated.
com.primus.searchstudio.CustomResultRanking	getResultRanking() Deprecated.
DocumentSetConstraint	getWeightedProperties() Deprecated.
java.lang.String	getWeightedPropertiesXml() Deprecated.
void	setLogicTree(com.primus.searchstudio.CustomLogicTree pLogicTree) Deprecated.
void	setPrefAnswerConstraints(DocumentSetConstraint prefAnswerConstraints) Deprecated.
void	setPriorInput(java.util.List priorInput) Deprecated. sets list of prior input values
void	setQueryText(java.lang.String queryText) Deprecated.
void	setReportDataControl(com.primus.searchstudio.ReportDataControl pReportDataControl) Deprecated.
void	setResultRanking(com.primus.searchstudio.CustomResultRanking pResultRanking) Deprecated.
void	setWeightedProperties(DocumentSetConstraint weightedProperties) 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

ClientQueryRequest

public ClientQueryRequest()

Deprecated.

ClientQueryRequest

public ClientQueryRequest(java.lang.String queryText,
                          java.util.List priorInput,
                          java.util.Map requestAttributes,
                          DocumentSetConstraint constraints,
                          DocumentSetConstraint prefAnswerConstraints,
                          DocumentSetConstraint weightedProperties,
                          ParserOptions parserOptions,
                          boolean loggingEnabled)

Deprecated.

Must get language for logging from parser options

Parameters:

queryText - question to be asked

priorInput - prior input

requestAttributes - Map of request attributes. See supporting documentation

constraints - XML constraint string. See supporting documentation

prefAnswerConstraints - XML preferred answer constraint string. See supporting documentation

weightedProperties - weighted properties. See supporting documentation

parserOptions - parser options xml. See supporting documentation

loggingEnabled - if true, request and responses are logged

See Also:

QueryConstants

ClientQueryRequest

public ClientQueryRequest(java.lang.String queryText)

Deprecated.

Simplest possible query request

Parameters:

queryText - the question to be asked

ClientQueryRequest

public ClientQueryRequest(java.lang.String queryText,
                          java.util.List priorInput,
                          java.util.Map requestAttributes,
                          DocumentSetConstraint constraints,
                          DocumentSetConstraint prefAnswerConstraints,
                          DocumentSetConstraint weightedProperties,
                          ParserOptions parserOptions,
                          com.primus.searchstudio.ReportDataControl reportDataControl,
                          com.primus.searchstudio.CustomResultRanking resultRanking,
                          com.primus.searchstudio.CustomLogicTree logicTree,
                          boolean loggingEnabled)

Deprecated.

Must get language for logging from parser options

Parameters:

queryText - question to be asked

priorInput - prior input

requestAttributes - Map of request attributes. See supporting documentation

constraints - XML constraint string. See supporting documentation

prefAnswerConstraints - XML preferred answer constraint string. See supporting documentation

weightedProperties - weighted properties. See supporting documentation

parserOptions - parser options xml. See supporting documentation

loggingEnabled - if true, request and responses are logged

See Also:

QueryConstants

Method Detail

getQueryText

public java.lang.String getQueryText()

Deprecated.

Returns:

query text

getPriorInput

public java.util.List getPriorInput()

Deprecated.

Returns:

list of prior input

setPriorInput

public void setPriorInput(java.util.List priorInput)

Deprecated.

sets list of prior input values

Parameters:

priorInput - List of strings

getLogicTree

public com.primus.searchstudio.CustomLogicTree getLogicTree()

Deprecated.

setLogicTree

public void setLogicTree(com.primus.searchstudio.CustomLogicTree pLogicTree)

Deprecated.

getReportDataControl

public com.primus.searchstudio.ReportDataControl getReportDataControl()

Deprecated.

setReportDataControl

public void setReportDataControl(com.primus.searchstudio.ReportDataControl pReportDataControl)

Deprecated.

getResultRanking

public com.primus.searchstudio.CustomResultRanking getResultRanking()

Deprecated.

setResultRanking

public void setResultRanking(com.primus.searchstudio.CustomResultRanking pResultRanking)

Deprecated.

getPrefAnswerConstraints

public DocumentSetConstraint getPrefAnswerConstraints()

Deprecated.

getPrefAnswerConstraintsXml

public java.lang.String getPrefAnswerConstraintsXml()

Deprecated.

setPrefAnswerConstraints

public void setPrefAnswerConstraints(DocumentSetConstraint prefAnswerConstraints)

Deprecated.

getWeightedProperties

public DocumentSetConstraint getWeightedProperties()

Deprecated.

getWeightedPropertiesXml

public java.lang.String getWeightedPropertiesXml()

Deprecated.

setWeightedProperties

public void setWeightedProperties(DocumentSetConstraint weightedProperties)

Deprecated.

setQueryText

public void setQueryText(java.lang.String queryText)

Deprecated.

Parameters:

queryText - query text

getRequestId

public int getRequestId()

Deprecated.

Returns:

ClientRequest.QUERY

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