atg.search.query.messages
Class SimilarDocsMessage

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

All Implemented Interfaces:

java.io.Serializable

public class SimilarDocsMessage
extends SearchMessage
implements java.io.Serializable

JMS message used as notification of a similar docs type search execution

See Also:

Serialized Form

Field Summary

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

Constructor Summary

SimilarDocsMessage(ClientSimilarDocsRequest pRequest)

Method Summary

java.lang.String	getJMSType() Get the JMS type
java.lang.String	getQueryMode() Return the query mode
java.lang.String	getQueryText() Return the query text.
ClientSimilarDocsRequest	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

SimilarDocsMessage

public SimilarDocsMessage(ClientSimilarDocsRequest pRequest)

Method Detail

getJMSType

public java.lang.String getJMSType()

Get the JMS type

Specified by:

getJMSType in class SearchMessage

Returns:

the JMS type

getRequest

public ClientSimilarDocsRequest 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 input property

Returns:

the query text

getQueryMode

public java.lang.String getQueryMode()

Return the query mode

Returns:

the query mode