cgl.narada.event
Interface EventProperties

All Known Implementing Classes:

EventPropertiesImpl

public interface EventProperties

Method Summary

byte[]	getBytes() Get a byte stream representation of the event header
Object	getLastModifier(Object propertyName) Get the last modifier of a certain property.
Object	getProperty(Object propertyName) Retrieve the value associated with a property.
Enumeration	getPropertyChanges(Object propertyName) Get a list of the changes associated with a mutable property.
Enumeration	getPropertyModifiers(Object propertyName) Gets alist of modifiers on a property.
Enumeration	getPropertyNames() Retrieve the list of property names
Enumeration	getPropertyNamesWithChangeTracking() Retrieve the list of property names with change tracking enabled.
boolean	hasProperties() Check if there are any properties associated with the event
boolean	hasPropertyChangeTracking(Object propertyName) Indicates if property change tracking has been enabled for the property in question.
boolean	isModified() Indicates if the EventProperties has been modified since the last time that it was serialized.
boolean	isMutable(Object propertyName) Check to see if this is a mutable property.
void	setImmutableProperty(Object propertyName, Object property, Object creator) Set an immutable property.
void	setMutableProperty(Object propertyName, Object property, Object modifier) Set a mutable property.
void	trackPropertyChanges(Object propertyName) Track the changes to a specific property.

Method Detail

hasProperties

boolean hasProperties()

Check if there are any properties associated with the event

getPropertyNames

Enumeration getPropertyNames()

Retrieve the list of property names

getPropertyNamesWithChangeTracking

Enumeration getPropertyNamesWithChangeTracking()

Retrieve the list of property names with change tracking enabled. Note that this just returns the list of mutable properties that have change tracking enabled for them.

getProperty

Object getProperty(Object propertyName)
                   throws NBEventException

Retrieve the value associated with a property. This method throws an exception if
(a) This propertyName is not a valid one.
(b) The specified propertyName is NULL

Throws:

NBEventException

setMutableProperty

void setMutableProperty(Object propertyName,
                        Object property,
                        Object modifier)
                        throws NBEventException

Set a mutable property. This method throws an exception if
(a) This property has been previously defined as a mutable property.
(b) Also neither the property or the property name can be NULL.

Throws:

NBEventException

setImmutableProperty

void setImmutableProperty(Object propertyName,
                          Object property,
                          Object creator)
                          throws NBEventException

Set an immutable property. This method throws an exception if
(a) This immutable property already exists.
(b) Also neither the property or the property name can be NULL.

Throws:

NBEventException

isMutable

boolean isMutable(Object propertyName)
                  throws NBEventException

Check to see if this is a mutable property. This method throws an exception if
(a) This property does not exist
(a) The specified propetyName is NULL

Throws:

NBEventException

getLastModifier

Object getLastModifier(Object propertyName)
                       throws NBEventException

Get the last modifier of a certain property. This method works with both mutable and immutable properties. This method throws an exception if
(a) This property does not exist
(a) The specified propetyName is NULL

Throws:

NBEventException

trackPropertyChanges

void trackPropertyChanges(Object propertyName)
                          throws NBEventException

Track the changes to a specific property. This method throws an exception if
(a) This is an immutable property
(b) If this property does not exist.
(c) The specified propertyName is NULL

Throws:

NBEventException

hasPropertyChangeTracking

boolean hasPropertyChangeTracking(Object propertyName)
                                  throws NBEventException

Indicates if property change tracking has been enabled for the property in question. This method throws an exception if
(a) This property does not exist
(b) The specified propertyName is not NULL

Throws:

NBEventException

getPropertyChanges

Enumeration getPropertyChanges(Object propertyName)
                               throws NBEventException

Get a list of the changes associated with a mutable property. This method throws an exception if
(a) changeTracking was not enabled on this property
(b) The specified property does not exist
(c) The specified propertyName is NULL

Throws:

NBEventException

getPropertyModifiers

Enumeration getPropertyModifiers(Object propertyName)
                                 throws NBEventException

Gets alist of modifiers on a property. This method throws an exception if
(a) changeTracking was not enabled on this property
(b) The specified property does not exist
(c) The specified propertyName is NULL

Throws:

NBEventException

getBytes

byte[] getBytes()

Get a byte stream representation of the event header

isModified

boolean isModified()

Indicates if the EventProperties has been modified since the last time that it was serialized.