com.genesyslab.ail.event
Interface WorkbinEvent


public interface WorkbinEvent

An event reporting an interaction activity in a Workbin.

Since:
7.1

Nested Class Summary
static class WorkbinEvent.ActorType
          Enum for the possible actors that performed an action on the workbin.
static class WorkbinEvent.Operation
          Enum for the possible operations performed on an interaction that modified the workbin.
static class WorkbinEvent.WorkbinOperation
          Enum for the possible types of operation performed on a workbin.
 
Method Summary
 java.lang.String getActorId()
          Returns the ID of the actor responsible for the operation that affected this workbin's contents.
 WorkbinEvent.ActorType getActorType()
          Returns the type of actor responsible for the operation that affected this workbin's contents.
 java.util.Map getInteractionAttachedData()
          Returns the Attached data of the interaction.
 java.lang.String getInteractionId()
          Returns the ID of the interaction that was taken out of or placed into the workbin.
 WorkbinEvent.Operation getOperation()
          Returns the operation performed on this workbin.
 java.lang.String getParameter()
          Returns the String parameter for changes in the current workbin.
 java.lang.String getReason()
          Returns the String reason for changes in this workbin.
 Workbin getWorkbin()
          Returns the Workbin that has changed.
 WorkbinEvent.WorkbinOperation getWorkbinOperation()
          Returns the workbin operation of this event.
 

Method Detail

getWorkbin

Workbin getWorkbin()
Returns the Workbin that has changed.


getParameter

java.lang.String getParameter()
Returns the String parameter for changes in the current workbin.


getActorType

WorkbinEvent.ActorType getActorType()
Returns the type of actor responsible for the operation that affected this workbin's contents.


getActorId

java.lang.String getActorId()
Returns the ID of the actor responsible for the operation that affected this workbin's contents.


getOperation

WorkbinEvent.Operation getOperation()
Returns the operation performed on this workbin.


getWorkbinOperation

WorkbinEvent.WorkbinOperation getWorkbinOperation()
Returns the workbin operation of this event. Can be null, namely if only the attached data of the interaction were modified.


getInteractionAttachedData

java.util.Map getInteractionAttachedData()
Returns the Attached data of the interaction. They might have been modified, especially if #getWorkbinOperation is null.


getInteractionId

java.lang.String getInteractionId()
Returns the ID of the interaction that was taken out of or placed into the workbin.


getReason

java.lang.String getReason()
Returns the String reason for changes in this workbin.