atg.search.query.messages
Class QueryMessage

java.lang.Object
  atg.search.query.messages.SearchMessage
      atg.search.query.messages.QueryMessage

All Implemented Interfaces:

java.io.Serializable

public class QueryMessage
extends SearchMessage
implements java.io.Serializable

A message corresponding to a <query> request/response

See Also:

Serialized Form

Field Summary

static java.lang.String	CLASS_VERSION
static java.lang.String	JMS_MESSAGE_TYPE

Constructor Summary

QueryMessage(ClientQueryRequest pClientQueryRequest)
Create a message from the client request object

Method Summary

java.lang.String	getJMSType() Get the JMS type
int	getPageNumber() Returns 1 based page number (adds 1 to query's pageNum attribute)
java.lang.String	getQueryMode() Return the query mode
java.lang.String	getQueryText() Return the query text.
ClientQueryRequest	getRequest() Return the request object used to generate this query

Methods inherited from class atg.search.query.messages.SearchMessage

getClientRequest, getOpitonSetName, getResultCount, getResults, getSiteName, getUserProfile, parseInt, setOptionSetName, setResults, setSiteName, setUserProfile

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

JMS_MESSAGE_TYPE

public static final java.lang.String JMS_MESSAGE_TYPE

See Also:

Constant Field Values

Constructor Detail

QueryMessage

public QueryMessage(ClientQueryRequest pClientQueryRequest)

Create a message from the client request object

Parameters:

pClientQueryRequest - the request object

Method Detail

getJMSType

public java.lang.String getJMSType()

Get the JMS type

Specified by:

getJMSType in class SearchMessage

Returns:

the JMS type

getRequest

public ClientQueryRequest getRequest()

Return the request object used to generate this query

Returns:

the request for this message type

getQueryText

public java.lang.String getQueryText()

Return the query text. This value includes the request's queryText property, concatenated with any non-empty prior input values.

Returns:

the query text plus any prior input

getPageNumber

public int getPageNumber()

Returns 1 based page number (adds 1 to query's pageNum attribute)

Returns:

the one-based page number

getQueryMode

public java.lang.String getQueryMode()

Return the query mode

Returns:

the query mode