atg.search.query.messages
Class BrowseMessage

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

public class BrowseMessage
extends SearchMessage
implements java.io.Serializable

A JMS message sent as notification of a Browse (ClientCategoryRequest) search execution.

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
           
static java.lang.String JMS_MESSAGE_TYPE
           
 
Constructor Summary
BrowseMessage(ClientCategoryRequest pRequest)
          Create a message from the request object
 
Method Summary
 java.lang.String getJMSType()
          Get the JMS type
 java.lang.String getQueryText()
          Return the query text.
 ClientCategoryRequest 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

BrowseMessage

public BrowseMessage(ClientCategoryRequest pRequest)
Create a message from the request object

Parameters:
pRequest - the client browse 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 ClientCategoryRequest 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 is just the request's queryText property

Returns:
the query text