com.genesyslab.ail.workflow
Interface AgentWorkbin

All Superinterfaces:
IdObject, Workbin

public interface AgentWorkbin
extends Workbin

A workbin that is defined by agent. Workbins can be defined either by agent, agent group, place, or place group in the Configuration Layer.

Since:
7.1

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.workflow.Workbin
Workbin.Type
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.IdObject
IdObject.ObjectType
 
Method Summary
 java.util.Collection getContent(Agent agent)
          Returns the contents of this workbin for another agent.
 java.util.Collection getContentForAgent(java.lang.String agent_id)
          Returns the contents of this workbin for another agent.
 void put(InteractionMultimedia interaction, Agent agent)
          Places an interaction into the workbin of another agent.
 void put(InteractionMultimedia interaction, Agent agent, java.lang.String reason, java.lang.String reason_description)
          Places an interaction into the workbin of another agent and specifies a reason for this action.
 void put(InteractionMultimedia interaction, java.lang.String agent_id, java.lang.String reason, java.lang.String reason_description)
          Places an interaction into the workbin of another agent and specifies a reason for this action.
 
Methods inherited from interface com.genesyslab.ail.workflow.Workbin
addWorkbinListener, addWorkbinListener, getContent, getContent, getContentForAll, getDisplayName, getName, getPlace, getSortedContentForAll, getType, getView, put, put, removeWorkbinListener
 
Methods inherited from interface com.genesyslab.ail.IdObject
getId, getObjectType
 

Method Detail

getContent

java.util.Collection getContent(Agent agent)
                                throws RequestFailedException
Returns the contents of this workbin for another agent.

Parameters:
agent - the agent whose workbin contents are required. Can be null; if this value is null, the default behaviour is Workbin.getContent().
Returns:
a Collection of InteractionMultimediaSummary
Throws:
IsServiceException - exception thrown if there is a problem with Interaction Server.
RequestFailedException

getContentForAgent

java.util.Collection getContentForAgent(java.lang.String agent_id)
                                        throws RequestFailedException
Returns the contents of this workbin for another agent.

Parameters:
agent_id - the agent ID whose workbin contents are required. Can be null; if this value is null, the default behaviour is Workbin.getContent().
Returns:
a Collection of InteractionMultimediaSummary
Throws:
IsServiceException - exception thrown if there is a problem with Interaction Server.
RequestFailedException

put

void put(InteractionMultimedia interaction,
         Agent agent)
         throws RequestFailedException
Places an interaction into the workbin of another agent.

Parameters:
interaction - the interaction to be put into the workbin.
agent - the agent into whose workbin the interaction will be put. Can be null; if this value is null, the default behaviour is Workbin.put(com.genesyslab.ail.InteractionMultimedia).
Throws:
IsServiceException - exception thrown if there is a problem with Interaction Server.
RequestFailedException

put

void put(InteractionMultimedia interaction,
         Agent agent,
         java.lang.String reason,
         java.lang.String reason_description)
         throws RequestFailedException
Places an interaction into the workbin of another agent and specifies a reason for this action.

Parameters:
interaction - the interaction to be put into the workbin.
agent - the agent into whose workbin the interaction will be put. Can be null; If this value is null, the default behaviour is Workbin.put(com.genesyslab.ail.InteractionMultimedia).
reason - this action's reason.
reason_description - the reason's description.
Throws:
IsServiceException - exception thrown if there is a problem with Interaction Server.
RequestFailedException

put

void put(InteractionMultimedia interaction,
         java.lang.String agent_id,
         java.lang.String reason,
         java.lang.String reason_description)
         throws RequestFailedException
Places an interaction into the workbin of another agent and specifies a reason for this action.

Parameters:
interaction - the interaction to be put into the workbin.
agent_id - the ID of agent into whose workbin the interaction will be put.
reason - the action's reason.
reason_description - the reason's description.
Throws:
IsServiceException - exception thrown if there is an issue with Interaction Server.
RequestFailedException