atg.userprofiling.dms
Class ClickThroughMessage

java.lang.Object
  atg.nucleus.dms.DASMessage
      atg.userprofiling.dms.DPSMessage
          atg.userprofiling.dms.ClickThroughMessage

All Implemented Interfaces:

java.io.Serializable

public class ClickThroughMessage
extends DPSMessage

This is a JMS Message that holds information about the context in which a link was clicked. It contains the following properties:

• sourceNames - an array of user-defined keywords that enables one to logically group specific links together. This is useful for scenarios e.g. wait for the user to click a link with a sourceName of "BikePromos".
• sourcePath - the request pathInfo of the referring page, that is, the page in which the clicked link was embedded.
• destinationPath - the pathInfo of the request generated by the clicked link

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

ClickThroughMessage()
Creates a new blank ClickThroughMessage

ClickThroughMessage(java.lang.String pProfileId)

ClickThroughMessage(java.lang.String pSourcePath, java.lang.String pDestinationPath, java.lang.String pSourceScenarioPathInfo, java.lang.String pDestinationScenarioPathInfo, java.lang.String[] pSourceNames, java.lang.String pProfileId)

Method Summary

java.lang.String	getDestinationPath()
java.lang.String	getDestinationScenarioPathInfo() Get property DestinationScenarioPathInfo
java.lang.String	getReportingSourceNames() Returns a comma-separated string of each of the source names set for this message.
java.lang.String[]	getSourceNames()
java.lang.String	getSourcePath()
java.lang.String	getSourceScenarioPathInfo() Get property SourceScenarioPathInfo
void	setDestinationPath(java.lang.String pDestinationPath) Sets the destinationPath for this Message.
void	setDestinationScenarioPathInfo(java.lang.String pDestinationScenarioPathInfo) Set property DestinationScenarioPathInfo
void	setSourceNames(java.lang.String[] pSourceNames) Sets the sourceNames for this Message
void	setSourcePath(java.lang.String pSourcePath) This sets the sourcePath for this Message.
void	setSourceScenarioPathInfo(java.lang.String pSourceScenarioPathInfo) Set property SourceScenarioPathInfo
protected java.lang.String	toStringProperties() Returns the String representation of all the public properties of this message.

Methods inherited from class atg.userprofiling.dms.DPSMessage

getParentSessionId, getProfileId, getScenarioPathInfo, getSessionId, setParentSessionId, setProfileId, setScenarioPathInfo, setSessionId

Methods inherited from class atg.nucleus.dms.DASMessage

limitSize, toString

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ClickThroughMessage

public ClickThroughMessage()

Creates a new blank ClickThroughMessage

ClickThroughMessage

public ClickThroughMessage(java.lang.String pProfileId)

ClickThroughMessage

public ClickThroughMessage(java.lang.String pSourcePath,
                           java.lang.String pDestinationPath,
                           java.lang.String pSourceScenarioPathInfo,
                           java.lang.String pDestinationScenarioPathInfo,
                           java.lang.String[] pSourceNames,
                           java.lang.String pProfileId)

Method Detail

setSourcePath

public void setSourcePath(java.lang.String pSourcePath)

This sets the sourcePath for this Message. The sourcePath represents the path info of the referring page which contains the clicked link

Parameters:

pSourcePath - - the path info of the referring page

getSourcePath

public java.lang.String getSourcePath()

Returns:

the source path for this Message

setDestinationPath

public void setDestinationPath(java.lang.String pDestinationPath)

Sets the destinationPath for this Message. The destinationPath is the path info of the clicked link

Parameters:

pDestinationPath - - the path info of the clicked link

getDestinationPath

public java.lang.String getDestinationPath()

Returns:

the destinationPath of this Message

setSourceNames

public void setSourceNames(java.lang.String[] pSourceNames)

Sets the sourceNames for this Message

Parameters:

pSourceName - - the user-defined logical names for this clicked link

getSourceNames

public java.lang.String[] getSourceNames()

Returns:

the sourceName for this Message

getReportingSourceNames

public java.lang.String getReportingSourceNames()

Returns a comma-separated string of each of the source names set for this message. This is only used for reporting purposes.

Returns:

a comma-separated string of each of the source names set for this message.

setSourceScenarioPathInfo

public void setSourceScenarioPathInfo(java.lang.String pSourceScenarioPathInfo)

Set property SourceScenarioPathInfo

Parameters:

pSourceScenarioPathInfo - new value to set

getSourceScenarioPathInfo

public java.lang.String getSourceScenarioPathInfo()

Get property SourceScenarioPathInfo

Returns:

SourceScenarioPathInfo

setDestinationScenarioPathInfo

public void setDestinationScenarioPathInfo(java.lang.String pDestinationScenarioPathInfo)

Set property DestinationScenarioPathInfo

Parameters:

pDestinationScenarioPathInfo - new value to set

getDestinationScenarioPathInfo

public java.lang.String getDestinationScenarioPathInfo()

Get property DestinationScenarioPathInfo

Returns:

DestinationScenarioPathInfo

toStringProperties

protected java.lang.String toStringProperties()

Returns the String representation of all the public properties of this message.

Overrides:

toStringProperties in class DPSMessage