com.neurosys.events

Class Feedback<E,S extends FlowStatus>

java.lang.Object

com.neurosys.domain.ModelObject

com.neurosys.events.Feedback<E,S>

Type Parameters:

E - as any Event

S - as FlowStatus

All Implemented Interfaces:

Attributes, Serializable

public class Feedback<E,S extends FlowStatus>
extends ModelObject
implements Attributes

A Feedback object for event with callback.
Useful in synchronous situations where we may want more structure to feedback or callbacks.
A feedback is something that can be sent to a callback for a change event.

Author:

Arjun Dhar

See Also:

FlowStatus, SynchronousFlowStatusChange, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Feedback()

Method Summary

Modifier and Type	Method and Description
Object	addAttribute(String name, Object value)
Map	getAttributes() Any optional feedback properties
Object	getAttributeValue(String name) Accessor to get the value and encapsulate how the value comes from the Attributes.Attribute
E	getEvent() The event over which we are getting feedback
String	getEventSenderId() The user, process or container Id that owns the event
Exception	getException() Any Exception
Date	getLastUpdated() The time the status was changed.
S	getPastStatus() The FlowStatus type ; before event occoured.
String	getRecipientId() The id of the recipient of the event that is transmitting this feedback
S	getStatus() Present status as FlowStatus type Note: incase exception is no null then the tokenStatus may reflect the same as pastStatus or be null.
Object	setAttribute(String name, Object value) This method encapsulates the responsibility of ensuring the @link Attribute} can be set into the entity, including null checks, initializations, any relations between Attributes and Attribute.
void	setAttributes(ImmutableValueHashMap attributes) Any optional feedback properties
void	setEvent(E event) The event over which we are getting feedback
void	setEventSenderId(String eventSenderId) The user, process or container Id that owns the event
void	setException(Exception exception) Any Exception
void	setLastUpdated(Date lastUpdated) The time the status was changed.
void	setPastStatus(S pastStatus) The FlowStatus type ; before event occoured.
void	setRecipientId(String recipientId) The id of the recipient of the event that is transmitting this feedback
void	setStatus(S status) Present status as FlowStatus type Note: incase exception is no null then the tokenStatus may reflect the same as pastStatus or be null.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Feedback

public Feedback()

Method Detail

getEvent

public E getEvent()

The event over which we are getting feedback

Can be null:

false

setEvent

public void setEvent(E event)

The event over which we are getting feedback

Can be null:

false

getEventSenderId

public String getEventSenderId()

The user, process or container Id that owns the event

Can be null:

false

setEventSenderId

public void setEventSenderId(String eventSenderId)

The user, process or container Id that owns the event

Can be null:

false

getRecipientId

public String getRecipientId()

The id of the recipient of the event that is transmitting this feedback

setRecipientId

public void setRecipientId(String recipientId)

The id of the recipient of the event that is transmitting this feedback

getPastStatus

public S getPastStatus()

The FlowStatus type ; before event occoured.

setPastStatus

public void setPastStatus(S pastStatus)

The FlowStatus type ; before event occoured.

getStatus

public S getStatus()

Present status as FlowStatus type Note: incase exception is no null then the tokenStatus may reflect the same as pastStatus or be null.

Can be null:

true

setStatus

public void setStatus(S status)

Present status as FlowStatus type Note: incase exception is no null then the tokenStatus may reflect the same as pastStatus or be null.

Can be null:

true

getLastUpdated

public Date getLastUpdated()

The time the status was changed. The word last is important as multiple events can modify a feedback. This reflects the last one to update the Feedback object

setLastUpdated

public void setLastUpdated(Date lastUpdated)

The time the status was changed. The word last is important as multiple events can modify a feedback. This reflects the last one to update the Feedback object

getAttributes

public Map getAttributes()

Any optional feedback properties

Can be null:

true

setAttributes

public void setAttributes(ImmutableValueHashMap attributes)

Any optional feedback properties

Can be null:

true

getException

public Exception getException()

Any Exception

Can be null:

true

setException

public void setException(Exception exception)

Any Exception

Can be null:

true

setAttribute

public Object setAttribute(String name,
                           Object value)

Description copied from interface: Attributes

This method encapsulates the responsibility of ensuring the @link Attribute} can be set into the entity, including null checks, initializations, any relations between Attributes and Attribute.

Specified by:

setAttribute in interface Attributes

Parameters:

name - as String

value - as value type

Returns:

this object

See Also:

addAttribute(String, Object)

getAttributeValue

public Object getAttributeValue(String name)

Description copied from interface: Attributes

Accessor to get the value and encapsulate how the value comes from the Attributes.Attribute

Specified by:

getAttributeValue in interface Attributes

Parameters:

name - as String

Returns:

null or the value of the Attribute

addAttribute

public Object addAttribute(String name,
                           Object value)
                    throws ReadOnlyException,
                           IllegalArgumentException

Throws:

ReadOnlyException

IllegalArgumentException

toString

public String toString()

Overrides:

toString in class Object