atg.userprofiling.dms

Class ProfilePropertyUpdateMessage

java.lang.Object

atg.nucleus.dms.DASMessage

atg.userprofiling.dms.DPSMessage

atg.userprofiling.dms.ProfilePropertyUpdateMessage

All Implemented Interfaces:

java.io.Serializable

public class ProfilePropertyUpdateMessage
extends DPSMessage

This JMS Message will be sent by DPS when a user changes one of his profile traits, like maritalStatus for example.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected double	mChangeAmount
protected double	mChangePercentage
protected int	mChangeSign
protected java.lang.Object[]	mElementsAdded
protected java.lang.Object[]	mElementsRemoved
protected java.lang.Object	mNewValue
protected java.lang.Object	mOldValue
protected java.lang.String	mPropertyPath

Fields inherited from class atg.userprofiling.dms.DPSMessage

SITE_GROUP_STORAGE_ADAPTER_PATH

Constructor Summary

Constructors

Constructor and Description
ProfilePropertyUpdateMessage()
ProfilePropertyUpdateMessage(java.lang.String pPropertyPath, java.lang.Object pOldValue, java.lang.Object pNewValue, int pChangeSign, double pChangeAmount, double pChangePercentage, java.lang.Object[] pElementsAdded, java.lang.Object[] pElementsRemoved, java.lang.String pProfileId) Constructs an instance of ProfileUpdateMessage

Method Summary

Modifier and Type	Method and Description
double	getChangeAmount() Gets the changeAmount property
double	getChangePercentage() Gets the changePercentage property
int	getChangeSign() Gets the changeSign property
java.lang.Object[]	getElementsAdded() Gets the elements added property
java.lang.Object[]	getElementsRemoved() Gets the elements removed property
java.lang.Object	getNewValue() Gets the newValue property
java.lang.Object	getOldValue() Gets the oldValue property
java.lang.String	getPropertyPath() Gets the propertyPath property
java.lang.Double	getReportingChangeAmount() Returns a Double representation of the changeAmount property, for reporting purposes only.
java.lang.Double	getReportingChangePercentage() Returns a Double representation of the changePercentage property, for reporting purposes only.
java.lang.String	getReportingChangeSign() Returns a String representation of the changeSign property, for reporting purposes only.
java.lang.String	getReportingElementsAdded() Returns a String representation of the elementsAdded property, for reporting purposes only.
java.lang.String	getReportingElementsRemoved() Returns a String representation of the elementsRemoved property, for reporting purposes only.
java.lang.String	getReportingNewValue() Returns a String representation of the newValue property, for reporting purposes only.
java.lang.String	getReportingOldValue() Returns a String representation of the oldValue property, for reporting purposes only.
void	setChangeAmount(double pChangeAmount) Sets the changeAmount property
void	setChangePercentage(double pChangePercentage) Sets the changePercentage property
void	setChangeSign(int pChangeSign) Sets the changeSign property
void	setElementsAdded(java.lang.Object[] pElementsAdded) Sets the elements Added property
void	setElementsRemoved(java.lang.Object[] pElementsRemoved) Sets the elements Removed property
void	setNewValue(java.lang.Object pNewValue) Sets the newValue property
void	setOldValue(java.lang.Object pOldValue) Sets the oldValue property
void	setPropertyPath(java.lang.String pPropertyPath) Sets the propertyPath property
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, getRealmId, getScenarioPathInfo, getSessionId, getSiteGroupIds, getSiteId, setParentSessionId, setProfileId, setRealmId, 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

mPropertyPath

protected java.lang.String mPropertyPath

mOldValue

protected java.lang.Object mOldValue

mNewValue

protected java.lang.Object mNewValue

mChangeSign

protected int mChangeSign

mChangeAmount

protected double mChangeAmount

mChangePercentage

protected double mChangePercentage

mElementsAdded

protected java.lang.Object[] mElementsAdded

mElementsRemoved

protected java.lang.Object[] mElementsRemoved

Constructor Detail

ProfilePropertyUpdateMessage

public ProfilePropertyUpdateMessage()

ProfilePropertyUpdateMessage

public ProfilePropertyUpdateMessage(java.lang.String pPropertyPath,
                                    java.lang.Object pOldValue,
                                    java.lang.Object pNewValue,
                                    int pChangeSign,
                                    double pChangeAmount,
                                    double pChangePercentage,
                                    java.lang.Object[] pElementsAdded,
                                    java.lang.Object[] pElementsRemoved,
                                    java.lang.String pProfileId)

Constructs an instance of ProfileUpdateMessage

Parameters:

pPropertyPath - the path of the property that changed

pOldValue - the value that this property was before the change

pNewValue - the value that this property was changed to

pChangeSign - for comparable types, indicates whether the value has increased or decreased, zero indicates no change or not comparable

pChangeAmount - if property is a Number type, the absolute value of the difference between oldValue and newValue

pChangePercentage - if property is a Number type, the absolute value of the percent difference between oldValue and newValue

pElementsAdded - if property is an array or Collection type, an array of elements which are members of newValue but not members of oldvalue

pElementsRemoved - if property is an array or Collection type, an array of elements which are members of oldValue but not members of newValue

Method Detail

setPropertyPath

public void setPropertyPath(java.lang.String pPropertyPath)

Sets the propertyPath property

Parameters:

pPropertyPath - the property that has changed (e.g, "maritalStatus" or "homeAddress.city"

getPropertyPath

public java.lang.String getPropertyPath()

Gets the propertyPath property

Returns:

the propertyPath of the property that has changed.

setOldValue

public void setOldValue(java.lang.Object pOldValue)

Sets the oldValue property

Parameters:

pOldValue - containing the property value before the change

getOldValue

public java.lang.Object getOldValue()

Gets the oldValue property

Returns:

the oldValue containing the property value before the change

setNewValue

public void setNewValue(java.lang.Object pNewValue)

Sets the newValue property

Parameters:

pNewValue - containing the value that the property has been changed to.

getNewValue

public java.lang.Object getNewValue()

Gets the newValue property

Returns:

the newValue containing the value that the property has been changed to.

setChangeSign

public void setChangeSign(int pChangeSign)

Sets the changeSign property

Parameters:

pChangeSign, - for comparable type properties, indicates if the value has increased or decreased. A zero value indicates either "no change", or "not comparable" A positive value indicates an increase A negative value indicates a decrease

getChangeSign

public int getChangeSign()

Gets the changeSign property

Returns:

the changeSign for comparable type properties indicating if the value has increased or decreased.

setChangeAmount

public void setChangeAmount(double pChangeAmount)

Sets the changeAmount property

Parameters:

pChangeAmount - for number type properties, the absolute value of the difference between old and new value

getChangeAmount

public double getChangeAmount()

Gets the changeAmount property

Returns:

the changeAmount for number type properties, the absolute value of difference between old and new value

setChangePercentage

public void setChangePercentage(double pChangePercentage)

Sets the changePercentage property

Parameters:

pChangePercentage, - for number type properties, the absolute value of the percent difference between old and new value

getChangePercentage

public double getChangePercentage()

Gets the changePercentage property

Returns:

the changePercentage for number type properties, the absolute value of the percent difference between old and new value

setElementsAdded

public void setElementsAdded(java.lang.Object[] pElementsAdded)

Sets the elements Added property

Parameters:

pElementsAdded - for array or collection type properties, an array of elements which memebers are of newValue but not members of oldValue

getElementsAdded

public java.lang.Object[] getElementsAdded()

Gets the elements added property

Returns:

the elementsAdded for array or collection type properties, an array of elements which memebers are of newValue but not members of oldValue

setElementsRemoved

public void setElementsRemoved(java.lang.Object[] pElementsRemoved)

Sets the elements Removed property

Parameters:

pElementsRemoved - for array or collection type properties, an array of elements which memebers are of oldValue but not members of newValue

getElementsRemoved

public java.lang.Object[] getElementsRemoved()

Gets the elements removed property

Returns:

the elementsRemoved for array or collection type properties, an array of elements which memebers are of oldValue but not members of newValue

getReportingOldValue

public java.lang.String getReportingOldValue()

Returns a String representation of the oldValue property, for reporting purposes only.

getReportingNewValue

public java.lang.String getReportingNewValue()

Returns a String representation of the newValue property, for reporting purposes only.

getReportingChangeSign

public java.lang.String getReportingChangeSign()

Returns a String representation of the changeSign property, for reporting purposes only.

getReportingChangeAmount

public java.lang.Double getReportingChangeAmount()

Returns a Double representation of the changeAmount property, for reporting purposes only.

getReportingChangePercentage

public java.lang.Double getReportingChangePercentage()

Returns a Double representation of the changePercentage property, for reporting purposes only.

getReportingElementsAdded

public java.lang.String getReportingElementsAdded()

Returns a String representation of the elementsAdded property, for reporting purposes only.

getReportingElementsRemoved

public java.lang.String getReportingElementsRemoved()

Returns a String representation of the elementsRemoved property, for reporting purposes only.

toStringProperties

protected java.lang.String toStringProperties()

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

Overrides:

toStringProperties in class DPSMessage