com.communote.server.api.core.property

Class PropertyEvent

java.lang.Object

com.communote.server.api.core.property.PropertyEvent

All Implemented Interfaces:

Event, Serializable

public class PropertyEvent
extends Object
implements Event

Describes an event of a changed property.

Author:

Communote GmbH - http://www.communote.com/

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropertyEvent.PropertyEventType The property event type defines why this event was triggered

Constructor Summary

Constructors

Constructor and Description
PropertyEvent(Long objectId, PropertyType propertyType, String keyGroup, String key)

Method Summary

Modifier and Type	Method and Description
String	getKey()
String	getKeyGroup()
String	getNewValue()
Long	getObjectId()
String	getOldValue()
PropertyEvent.PropertyEventType	getPropertyEventType()
PropertyType	getPropertyType()
Long	getUserId()
void	setNewValue(String newValue)
void	setOldValue(String oldValue)
void	setPropertyEventType(PropertyEvent.PropertyEventType propertyEventType)
void	setUserId(Long id) Set the ID of the user associated with a modified UserNoteProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyEvent

public PropertyEvent(Long objectId,
                     PropertyType propertyType,
                     String keyGroup,
                     String key)

Parameters:

objectId - the id of the object this property change is referring too. The type of the property can be inferred from the associated propertyType

propertyType - the type of the changed property

keyGroup - the key group

key - the key of the property

Method Detail

getKey

public String getKey()

Returns:

the key of the changed property

getKeyGroup

public String getKeyGroup()

Returns:

the key group of the changed property

getNewValue

public String getNewValue()

Returns:

the new value of the changed property, will be null on delete or if it is not a StringProperty

getObjectId

public Long getObjectId()

Returns:

the id of the referring object. The type is defined by getPropertyType() For a PropertyType.UserNoteProperty this id refers to the noteId. For the userId use getUserId()

getOldValue

public String getOldValue()

Returns:

the old value of the property, will be null on create or if the property is not a StringProperty

getPropertyEventType

public PropertyEvent.PropertyEventType getPropertyEventType()

Returns:

the type indicating if the property has been created, updated or deleted

getPropertyType

public PropertyType getPropertyType()

Returns:

the type of the property

getUserId

public Long getUserId()

Returns:

the ID of the user associated with a UserNoteProperty. Will be null if the event was created for another property type.

setNewValue

public void setNewValue(String newValue)

Parameters:

newValue - sets the new value (see getNewValue() for more details)

setOldValue

public void setOldValue(String oldValue)

Parameters:

oldValue - sets the old value (see getOldValue() for more details)

setPropertyEventType

public void setPropertyEventType(PropertyEvent.PropertyEventType propertyEventType)

Parameters:

propertyEventType - sets the type of event

setUserId

public void setUserId(Long id)

Set the ID of the user associated with a modified UserNoteProperty

Parameters:

id - the ID of the user