com.genesyslab.ail.workflow
Interface Workbin

All Superinterfaces:
IdObject
All Known Subinterfaces:
AgentGroupWorkbin, AgentWorkbin, PlaceGroupWorkbin, PlaceWorkbin

public interface Workbin
extends IdObject

A Workbin is a container for interactions defined by agent or by place in the Configuration Layer.

Since:
7.0

Nested Class Summary
static class Workbin.Type
          Enumerates the possible types of workbins.
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.IdObject
IdObject.ObjectType
 
Method Summary
 void addWorkbinListener(WorkbinListener listener)
          Adds a WorkbinListener to the listener list for events on this workbin.
 void addWorkbinListener(WorkbinListener listener, boolean includePropertyChanges)
          Adds a WorkbinListener to the listener list for events on this workbin.
 java.util.Collection getContent()
          Returns the content of this workbin for this agent or place.
 InteractionMultimediaSummary getContent(java.lang.String interactionID)
          Returns the interaction of this workbin for all agents or places.
 java.util.Collection getContentForAll()
          Returns the content of this workbin for all agents or places.
 java.lang.String getDisplayName()
          Returns this workbin's display name.
 java.lang.String getName()
          Returns the name of this workbin.
 Place getPlace()
          Returns the place of this instance of the workbin.
 java.util.Map getSortedContentForAll()
          Returns the content of this workbin for all agents, sorted into a Map.
 Workbin.Type getType()
          Returns the type of this workbin.
 java.lang.String getView()
          Returns the view on which this Workbin relies.
 void put(InteractionMultimedia interaction)
          Places this interaction into this workbin for this agent or place.
 void put(InteractionMultimedia interaction, java.lang.String reason, java.lang.String reason_description)
          Places this interaction into this workbin for this agent or place, and specifies a reason for this action.
 void removeWorkbinListener(WorkbinListener listener)
          Removes a WorkbinListener from the listener list for workbin events.
 
Methods inherited from interface com.genesyslab.ail.IdObject
getId, getObjectType
 

Method Detail

getName

java.lang.String getName()
Returns the name of this workbin.


getDisplayName

java.lang.String getDisplayName()
Returns this workbin's display name.

Use this display name for GUI purposes.


getType

Workbin.Type getType()
Returns the type of this workbin.


getView

java.lang.String getView()
Returns the view on which this Workbin relies. Views are defined in the Configuration Layer.

Returns:
the view as a String

getPlace

Place getPlace()
Returns the place of this instance of the workbin. It it the place of the WorkbinManager that has created this workbin.


getContent

java.util.Collection getContent()
                                throws RequestFailedException
Returns the content of this workbin for this agent or place.

Returns:
a List of InteractionMultimediaSummary.
Throws:
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedException

getContentForAll

java.util.Collection getContentForAll()
                                      throws RequestFailedException
Returns the content of this workbin for all agents or places.

Returns:
a List of InteractionMultimediaSummary.
Throws:
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedException

getSortedContentForAll

java.util.Map getSortedContentForAll()
                                     throws RequestFailedException
Returns the content of this workbin for all agents, sorted into a Map. The key is the agent user name (the agent ID) for an AgentWorkbin or the place ID for a PlaceWorkbin. The value is a Collection of InteractionMultimediaSummary.

Returns:
a Map of (String, Collection of (InteractionMultimediaSummary))
Throws:
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedException

put

void put(InteractionMultimedia interaction)
         throws RequestFailedException
Places this interaction into this workbin for this agent or place.

Throws:
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedException

put

void put(InteractionMultimedia interaction,
         java.lang.String reason,
         java.lang.String reason_description)
         throws RequestFailedException
Places this interaction into this workbin for this agent or place, and specifies a reason for this action.

Parameters:
reason - the reason of this action.
reason_description - the description of this reason.
Throws:
IsServiceException - if there is a problem with Interaction Server.
RequestFailedException

addWorkbinListener

void addWorkbinListener(WorkbinListener listener)
Adds a WorkbinListener to the listener list for events on this workbin.

See Also:
addWorkbinListener(WorkbinListener, boolean)

addWorkbinListener

void addWorkbinListener(WorkbinListener listener,
                        boolean includePropertyChanges)
                        throws RequestFailedException
Adds a WorkbinListener to the listener list for events on this workbin. This method allows to register for events about property modifications. Please note that it is not recommended to set includePropertyChanges to true for group workbins, because of the number of events that it could generate.

Parameters:
includePropertyChanges - registers for interaction property modifications. For technical reasons, this parameter is taken into account for the first listener on a given workbin. Additional listeners can only be registered with the same value.
Throws:
InvalidParameterException - if it is called again with a different value of includePropertyChanges
RequestFailedException
Since:
7.6.5

removeWorkbinListener

void removeWorkbinListener(WorkbinListener listener)
Removes a WorkbinListener from the listener list for workbin events.


getContent

InteractionMultimediaSummary getContent(java.lang.String interactionID)
                                        throws RequestFailedException
Returns the interaction of this workbin for all agents or places.

Parameters:
interactionID - the ID of the interaction.
Returns:
a InteractionMultimediaSummary.
Throws:
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedException