|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface Workbin
A Workbin is a container for interactions defined by agent or by place
in the Configuration Layer.
| 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 |
|---|
java.lang.String getName()
java.lang.String getDisplayName()
Use this display name for GUI purposes.
Workbin.Type getType()
java.lang.String getView()
Workbin relies. Views are defined in the
Configuration Layer.
StringPlace getPlace()
WorkbinManager that has created this workbin.
java.util.Collection getContent()
throws RequestFailedException
List of InteractionMultimediaSummary.
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedException
java.util.Collection getContentForAll()
throws RequestFailedException
List of InteractionMultimediaSummary.
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedException
java.util.Map getSortedContentForAll()
throws RequestFailedException
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.
Map of (String, Collection of
(InteractionMultimediaSummary))
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedException
void put(InteractionMultimedia interaction)
throws RequestFailedException
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedException
void put(InteractionMultimedia interaction,
java.lang.String reason,
java.lang.String reason_description)
throws RequestFailedException
reason - the reason of this action.reason_description - the description of this reason.
IsServiceException - if there is a problem with Interaction Server.
RequestFailedExceptionvoid addWorkbinListener(WorkbinListener listener)
WorkbinListener to the listener list for events on this workbin.
addWorkbinListener(WorkbinListener, boolean)
void addWorkbinListener(WorkbinListener listener,
boolean includePropertyChanges)
throws RequestFailedException
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.
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.
InvalidParameterException - if it is called again with a
different value of includePropertyChanges
RequestFailedExceptionvoid removeWorkbinListener(WorkbinListener listener)
WorkbinListener from the listener list for workbin events.
InteractionMultimediaSummary getContent(java.lang.String interactionID)
throws RequestFailedException
interactionID - the ID of the interaction.
InteractionMultimediaSummary.
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||