com.primus.ae.searchclient
Class ClientStructuredRequest

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

All Implemented Interfaces:

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

Deprecated. as of 9.0. Use StructuredQueryRequest instead.

public class ClientStructuredRequest
extends ClientRequestImpl

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

ClientStructuredRequest()
Deprecated.

ClientStructuredRequest(StructuredStatement[] statements)
Deprecated.

ClientStructuredRequest(StructuredStatement[] statements, java.util.Map requestAttributes, DocumentSetConstraint constraints, DocumentSetConstraint weightedProps, ParserOptions parsingOptions, boolean loggingEnabled)
Deprecated.

Method Summary

int	getRequestId() Deprecated.
StructuredStatement[]	getStatements() Deprecated.
DocumentSetConstraint	getWeightedProperties() Deprecated.
java.lang.String	getWeightedPropertiesXml() Deprecated.
void	setStatements(StructuredStatement[] statement) 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

ClientStructuredRequest

public ClientStructuredRequest()

Deprecated.

ClientStructuredRequest

public ClientStructuredRequest(StructuredStatement[] statements,
                               java.util.Map requestAttributes,
                               DocumentSetConstraint constraints,
                               DocumentSetConstraint weightedProps,
                               ParserOptions parsingOptions,
                               boolean loggingEnabled)

Deprecated.

Parameters:

statements - one or more statements that contains the input text for search and the name of text field

constraints - document set constraint.

weightedProps - weighted propery expression

parsingOptions - parser options xml. See supporting documentation

loggingEnabled - If true, request and responses will be logged

See Also:

StructuredQueryConstants

ClientStructuredRequest

public ClientStructuredRequest(StructuredStatement[] statements)

Deprecated.

Parameters:

statements - one or more statements that contains the input text for search and the name of text field

Method Detail

getStatements

public StructuredStatement[] getStatements()

Deprecated.

Returns:

statements one or more statements that contains the input text for search and the name of text field

setStatements

public void setStatements(StructuredStatement[] statement)

Deprecated.

Parameters:

statement - array of statements

getWeightedProperties

public DocumentSetConstraint getWeightedProperties()

Deprecated.

getWeightedPropertiesXml

public java.lang.String getWeightedPropertiesXml()

Deprecated.

setWeightedProperties

public void setWeightedProperties(DocumentSetConstraint weightedProperties)

Deprecated.

getRequestId

public int getRequestId()

Deprecated.

Returns:

ClientRequest.STRUCTQUERY

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