|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface InteractionMultimedia
A multimedia interaction handled by the Call Center.
| Nested Class Summary | |
|---|---|
static class |
InteractionMultimedia.StopProcessingReason
Constants that describe stop processing reasons. |
| Nested classes/interfaces inherited from interface com.genesyslab.ail.Interaction |
|---|
Interaction.Action, Interaction.Status, Interaction.Type |
| Nested classes/interfaces inherited from interface com.genesyslab.ail.AbstractInteraction |
|---|
AbstractInteraction.AbstractCallType |
| Method Summary | |
|---|---|
void |
addSuggestedCategories(java.util.Map suggested_categories)
Adds or updates the suggested categories for this interaction. |
void |
delete()
Deletes this interaction. |
java.util.Collection |
getAvailableQueuesForChildInteraction()
Returns the queues in which a child interaction can be created. |
java.util.Collection |
getAvailableQueuesForThisInteraction()
Returns the queues where this interaction can be put. |
java.lang.String |
getCategoryId()
Gets the identifier of the Category that was assigned to this interaction. |
java.lang.String |
getExternalId()
Gets the external identifier assigned to this interaction. |
java.lang.String |
getInteractionSubtype()
Returns the Subtype of this interaction. |
java.lang.String |
getInteractionType()
Returns the Type of this interaction. |
java.lang.Boolean |
getIsCategoryApproved()
Tells whether an agent has approved or disapproved the category that was suggested by Classification Server. |
int |
getMaxSubjectLength()
Returns the maximum length for a subject that is accepted by the Contact Server database. |
java.lang.String |
getMediaType()
Returns the Media of this interaction. |
java.lang.String |
getQueue()
Returns the identifier of the queue of this interaction. |
java.util.Map |
getSuggestedCategories()
Returns the suggested categories for this interaction. |
boolean |
isMarkDoneAvailable()
Returns true if this interaction can be stopped with no more processing. |
void |
placeInQueue(java.lang.String queue)
Places this interaction into this queue. |
void |
setAttachedData(java.lang.String key,
java.lang.Object value)
Sets an attached key-value pair. |
void |
setAvailableQueuesForChildInteraction(java.util.Collection queues)
Sets the list of queues in which a child interaction can be created. |
void |
setAvailableQueuesForThisInteraction(java.util.Collection queues)
Sets the queues to which this interaction can be sent. |
void |
setCategoryId(java.lang.String id)
Assigns a category to this interaction. |
void |
setExternalId(java.lang.String id)
Assigns an external identifier to this interaction. |
void |
setIsCategoryApproved(java.lang.Boolean _approval)
Sets the approval of the suggested category. |
void |
submit(java.lang.String queue)
Submits this interaction to the Interaction Server. |
void |
transferAgent(java.lang.String agent_id,
java.lang.String reason)
Transfers this interaction to another agent. |
void |
transferPlace(java.lang.String place_id,
java.lang.String reason)
Transfers this interaction to another agent. |
void |
transferQueue(java.lang.String queue,
java.lang.String reason)
Transfers this interaction to another agent through a queue. |
| Methods inherited from interface com.genesyslab.ail.Interaction |
|---|
answerCall, countOtherPendingInteractions, getContactId, getContentBinary, getContentBinaryMimeType, getContentBinarySize, getDateCreated, getDn, getEndDate, getMedia, getNotepad, getParentInteraction, getPlace, getStatus, getStructTextMimeType, getStructuredText, getSubject, getText, getType, getUserName, isDone, markDone, merge, releaseCall, save, setContactId, setContentBinary, setContentBinaryMimeType, setContentBinarySize, setNotepad, setStructTextMimeType, setStructuredText, setSubject, setText |
| Methods inherited from interface com.genesyslab.ail.AbstractInteraction |
|---|
addInteractionListener, getAttachedData, getAttachedData, getAttachedDataEx, getTConnectionId, queryStatus, removeAttachedData, removeInteractionListener, saveAttachedData, setAttachedData |
| Methods inherited from interface com.genesyslab.ail.Possible |
|---|
arePossible, isPossible |
| Methods inherited from interface com.genesyslab.ail.Savable |
|---|
getContactServerId, isDirty |
| Method Detail |
|---|
int getMaxSubjectLength()
java.lang.String getMediaType()
java.lang.String getInteractionType()
java.lang.String getInteractionSubtype()
void placeInQueue(java.lang.String queue)
throws RequestFailedException
queue - the identifier of the queue where to place this interaction. If
null, this interaction will be placed back into the queue where it originally
was.
NoPlaceException - if this interaction is not currently handled on a
Place.
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedException
void transferAgent(java.lang.String agent_id,
java.lang.String reason)
throws RequestFailedException
agent_id - the user name (the ID) of the agent to whom the interaction will be
transferred.reason - the reason for the transfer. Can be null.
NoPlaceException - if this interaction is not currently handeled on a
Place.+
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedException
void transferPlace(java.lang.String place_id,
java.lang.String reason)
throws RequestFailedException
place_id - the ID of the place of the agent to whom the interaction will be transferred.reason - the reason for the transfer. Can be null.
NoPlaceException - if this interaction is not currently handled on a
Place.
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedException
void transferQueue(java.lang.String queue,
java.lang.String reason)
throws RequestFailedException
queue - the ID of the queue where the router will take this interaction for distributionreason - the reason for the transfer. Can be null.
NoPlaceException - if this interaction is not currently handeled on a
Place.
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedException
void delete()
throws RequestFailedException
NoPlaceException - if this interaction is not currently handled on a
Place.
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedExceptionboolean isMarkDoneAvailable()
true if this interaction can be stopped with no more processing.
Interaction.markDone()java.util.Collection getAvailableQueuesForThisInteraction()
Collection of Queue.placeInQueue(java.lang.String)java.util.Collection getAvailableQueuesForChildInteraction()
Collection of Queue.placeInQueue(java.lang.String)
java.util.Map getSuggestedCategories()
throws RequestFailedException
Note: If the DATABASE service is not available, that is, if Universal Contact Server (UCS)
is not connected, SRL features are not available; in this case, do not call this method.
Map of (String category identifier, String
relevancy).
RequestFailedExceptionCategory
void addSuggestedCategories(java.util.Map suggested_categories)
throws RequestFailedException
Note: If the DATABASE service is not available, that is, if Universal Contact Server (UCS)
is not connected, SRL features are not available; in this case, do not call this method.
suggested_categories - the categories to set, as a Map of
(Stringcategory identifier, String relevancy).
RequestFailedExceptionjava.lang.String getCategoryId()
Category that was assigned to this interaction. A
Categorycan be assigned either by the Classification Server or by an agent at
desktop level.
Note: If the DATABASE service is not available, that is, if Universal Contact Server (UCS)
is not connected, SRL features are not available; in this case, do not call this method.
null if there is no category assigned to
this interaction.setCategoryId(java.lang.String)
void setCategoryId(java.lang.String id)
throws RequestFailedException
Note: If the DATABASE service is not available, that is, if Universal Contact Server (UCS)
is not connected, SRL features are not available; in this case, do not call this method.
id - the identifier of the category to assign.
RequestFailedExceptiongetCategoryId()
java.lang.Boolean getIsCategoryApproved()
throws RequestFailedException
null, no agent has given a feedback on the suggested
category. If Boolean.TRUE, an agent has approved it. If
Boolean.FALSE, an agent has disapproved it.
Note: If the DATABASE service is not available, that is, if Universal Contact Server (UCS)
is not connected, SRL features are not available; in this case, do not call this method.
RequestFailedException
void setIsCategoryApproved(java.lang.Boolean _approval)
throws RequestFailedException
Note: If the DATABASE service is not available, that is, if Universal Contact Server (UCS)
is not connected, SRL features are not available; in this case, do not call this method.
_approval - Boolean.TRUE means that the agent approves
it ;Boolean.FALSE means that the agent disapproves
it ;null means that the agent does not give a feedback.
RequestFailedExceptionjava.lang.String getQueue()
getQueue in interface InteractionQueuejava.lang.String getExternalId()
null if this interaction has no external identifier.setExternalId(java.lang.String)
void setExternalId(java.lang.String id)
throws RequestFailedException
id - the identifier to be assigned.
RequestFailedExceptiongetExternalId()
void submit(java.lang.String queue)
throws RequestFailedException
queue - the queue where the interaction will be placed in.
RequestFailedException
void setAvailableQueuesForThisInteraction(java.util.Collection queues)
throws RequestFailedException
queues - a Collection of Queue.
RequestFailedExceptionplaceInQueue(java.lang.String)
void setAvailableQueuesForChildInteraction(java.util.Collection queues)
throws RequestFailedException
Output Queues queues defined in the Interaction Workflow Designer (IWD).
queues - a Collection of Queue.
RequestFailedExceptionplaceInQueue(java.lang.String)
void setAttachedData(java.lang.String key,
java.lang.Object value)
AbstractInteraction.saveAttachedData()
to apply this modification.
setAttachedData in interface AbstractInteractionkey - The key of the pair.value - The value of the pair. Valid objects are:
String, Integer, List of Byte, or a byte[], List, containing those types of objects, Map, recursively containing the same types of pairs. null value is processed as if it were an empty String.for specific behaviour.,
for specific behaviour.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||