com.genesyslab.ail.workflow
Interface PlaceWorkbin

All Superinterfaces:
IdObject, Workbin

public interface PlaceWorkbin
extends Workbin

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

Since:
7.0

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(Place place)
          Returns the contents of the workbin for another place.
 java.util.Collection getContentForPlace(java.lang.String place_id)
          Returns the contents of the workbin for another place.
 void put(InteractionMultimedia interaction, Place place)
          Places an interaction into another place's workbin.
 void put(InteractionMultimedia interaction, Place place, java.lang.String reason, java.lang.String reason_description)
          Places an interaction into the workbin of another place and specifies a reason for this action.
 void put(InteractionMultimedia interaction, java.lang.String place_id, java.lang.String reason, java.lang.String reason_description)
          Places an interaction into the workbin of another place.
 
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(Place place)
                                throws RequestFailedException
Returns the contents of the workbin for another place.

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

getContentForPlace

java.util.Collection getContentForPlace(java.lang.String place_id)
                                        throws RequestFailedException
Returns the contents of the workbin for another place.

Parameters:
place_id - the place ID whose the workbin contents are required. Can be null. In this case, 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,
         Place place)
         throws RequestFailedException
Places an interaction into another place's workbin.

Parameters:
interaction - the interaction to be put into the workbin.
place - the place 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,
         Place place,
         java.lang.String reason,
         java.lang.String reason_description)
         throws RequestFailedException
Places an interaction into the workbin of another place and specifies a reason for this action.

Parameters:
interaction - the interaction to be put into the workbin.
place - the place 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 place_id,
         java.lang.String reason,
         java.lang.String reason_description)
         throws RequestFailedException
Places an interaction into the workbin of another place.

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