atg.userprofiling.dms
Class ViewItemMessage

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

All Implemented Interfaces:

java.io.Serializable

public class ViewItemMessage
extends DPSMessage

ViewItemMessage is a class which encapsulates the information regarding a repository item that is "viewed" by the end user. The class is meant to hold the information and to be serialized within an ObjectMessage that can be sent over JMS. Typically this object is instantiated and populated with the relevant information and is sent out on a topic or queue that can be acted upon by the underlying system. This feature can be used to note the viewing of such items as: Category, Product, Sku or a Catalog if they are modeled as repository items.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

ViewItemMessage()
Constructs a blank ViewItemMessage

ViewItemMessage(java.lang.String pProfileId)
Constructs a View Item message.

ViewItemMessage(java.lang.String pRepositoryName, java.lang.String pItemType, java.lang.String pRepositoryId, java.lang.String pFolder, java.lang.String pProfileId, RepositoryItem pItem, Targeter pTargeter)
Constructs a View Item message.

ViewItemMessage(java.lang.String pRepositoryName, java.lang.String pItemType, java.lang.String pRepositoryId, java.lang.String pFolder, java.lang.String pProfileId, RepositoryItem pItem, Targeter pTargeter, java.lang.String pPath)
Constructs a View Item message.

Method Summary

java.lang.String	getFolder()
RepositoryItem	getItem()
java.lang.String	getItemType()
java.lang.String	getPath()
java.lang.String	getRepositoryId()
java.lang.String	getRepositoryName()
Targeter	getTargeter()
void	setFolder(java.lang.String pFolder) The folder path that includes the item, if it is a content repository
void	setItem(RepositoryItem pItem) The repository item that was viewed.
void	setItemType(java.lang.String pItemType) The repository item type of the repository item that is passed.
void	setPath(java.lang.String pPath) The name of the page that contains this item.
void	setRepositoryId(java.lang.String pRepositoryId) The id of the repository.
void	setRepositoryName(java.lang.String pRepositoryName) The name of the repository that contains this item.
void	setTargeter(Targeter pTargeter) The targeter that was used to view the event.
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, getSiteId, setParentSessionId, setProfileId, setScenarioPathInfo, setSessionId, setSiteId, setSiteIdFromSiteContextManager

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

ViewItemMessage

public ViewItemMessage()

Constructs a blank ViewItemMessage

ViewItemMessage

public ViewItemMessage(java.lang.String pProfileId)

Constructs a View Item message.

ViewItemMessage

public ViewItemMessage(java.lang.String pRepositoryName,
                       java.lang.String pItemType,
                       java.lang.String pRepositoryId,
                       java.lang.String pFolder,
                       java.lang.String pProfileId,
                       RepositoryItem pItem,
                       Targeter pTargeter)

Constructs a View Item message.

ViewItemMessage

public ViewItemMessage(java.lang.String pRepositoryName,
                       java.lang.String pItemType,
                       java.lang.String pRepositoryId,
                       java.lang.String pFolder,
                       java.lang.String pProfileId,
                       RepositoryItem pItem,
                       Targeter pTargeter,
                       java.lang.String pPath)

Constructs a View Item message.

Method Detail

setPath

public void setPath(java.lang.String pPath)

The name of the page that contains this item.

Parameters:

the - name of the repository that contains this item.

getPath

public java.lang.String getPath()

Returns:

the name of the page that this item lives in.

setRepositoryName

public void setRepositoryName(java.lang.String pRepositoryName)

The name of the repository that contains this item.

Parameters:

the - name of the repository that contains this item.

getRepositoryName

public java.lang.String getRepositoryName()

Returns:

the name of the repository that this item lives in.

setFolder

public void setFolder(java.lang.String pFolder)

The folder path that includes the item, if it is a content repository

Parameters:

the - path of the containing folder

getFolder

public java.lang.String getFolder()

Returns:

the folder path.

setItemType

public void setItemType(java.lang.String pItemType)

The repository item type of the repository item that is passed.

Parameters:

the - repository item type.

getItemType

public java.lang.String getItemType()

Returns:

the repository item type

setRepositoryId

public void setRepositoryId(java.lang.String pRepositoryId)

The id of the repository.

Parameters:

the - repository id

getRepositoryId

public java.lang.String getRepositoryId()

Returns:

the repository id

setItem

public void setItem(RepositoryItem pItem)

The repository item that was viewed.

Parameters:

the - repository item that was viewed

getItem

public RepositoryItem getItem()

Returns:

the item that was viewed

setTargeter

public void setTargeter(Targeter pTargeter)

The targeter that was used to view the event. (Optional)

Parameters:

the - targeter that was used to view the event

getTargeter

public Targeter getTargeter()

Returns:

the Targeter that was used to view this item.

toStringProperties

protected java.lang.String toStringProperties()

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

Overrides:

toStringProperties in class DPSMessage