atg.search.query.messages
Class CategorizeMessage

java.lang.Object
  extended by atg.search.query.messages.SearchMessage
      extended by atg.search.query.messages.CategorizeMessage
All Implemented Interfaces:
java.io.Serializable

public class CategorizeMessage
extends SearchMessage
implements java.io.Serializable

A JMS message sent as notification of a Categorize (ClientCategorizeRequest) search execution.

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
           
static java.lang.String JMS_MESSAGE_TYPE
           
 
Constructor Summary
CategorizeMessage(ClientCategorizeRequest pRequest)
          Create a message from the request object
 
Method Summary
 java.lang.String getJMSType()
          Get the JMS type
 java.lang.String getQueryMode()
          Get the query mode string.
 java.lang.String getQueryText()
          Get the query text used in the search
 ClientCategorizeRequest 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

CategorizeMessage

public CategorizeMessage(ClientCategorizeRequest pRequest)
Create a message from the request object

Parameters:
pRequest - the client 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 ClientCategorizeRequest getRequest()
Return the request object used to generate this query

Returns:
the request for this message type

getQueryText

public java.lang.String getQueryText()
Get the query text used in the search

Returns:
the query text

getQueryMode

public java.lang.String getQueryMode()
Get the query mode string.

Returns:
the query mode string