atg.search.query.messages
Class ViewInContextMessage

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

All Implemented Interfaces:

java.io.Serializable

public class ViewInContextMessage
extends SearchMessage
implements java.io.Serializable

This class is a notification of the result of a <viewInContext> query

See Also:

Serialized Form

Field Summary

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

Constructor Summary

ViewInContextMessage(ClientVicRequest pRequest)
Create a view in context JMS message

Method Summary

java.lang.String	getDocContextId() Get the <docContextId> property value
java.lang.String	getInput() Get the input value
java.lang.String	getJMSType() Get the JMS type
java.lang.String	getProperty() Get the <property> tag's value
ClientVicRequest	getRequest() Return the request object used to generate this query
java.lang.String	getReturn() Get the return property of the request
java.lang.String	getUrl() Get the URL request value
java.lang.String	getValue() Get the <value> tag's value

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

ViewInContextMessage

public ViewInContextMessage(ClientVicRequest pRequest)

Create a view in context JMS message

Parameters:

pRequest - 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 ClientVicRequest getRequest()

Return the request object used to generate this query

Returns:

the request for this message type

getReturn

public java.lang.String getReturn()

Get the return property of the request

Returns:

the return property value

getDocContextId

public java.lang.String getDocContextId()

Get the <docContextId> property value

Returns:

the docContextId property value

getInput

public java.lang.String getInput()

Get the input value

Returns:

the input value

getUrl

public java.lang.String getUrl()

Get the URL request value

Returns:

the URL request value

getProperty

public java.lang.String getProperty()

Get the <property> tag's value

Returns:

the property value

getValue

public java.lang.String getValue()

Get the <value> tag's value

Returns:

the value value