com.genesyslab.ail
Interface InteractionMultimediaSummary

All Superinterfaces:
IdObject
All Known Subinterfaces:
InteractionOpenMediaSummary

public interface InteractionMultimediaSummary
extends IdObject

Summary information for a multimedia interaction.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.IdObject
IdObject.ObjectType
 
Method Summary
 java.util.Map getAttachedData()
          Returns the attached data of this interaction.
 java.lang.String getCaseId()
          Returns the ID of the case of this interaction.
 java.lang.String getContactId()
          Returns the ID of the contact of this interaction.
 java.lang.String getContactServerId()
          Returns the ID of this interaction in the Contact Server.
 java.util.Date getDateDelivered()
          Returns the date when this interaction was delivered.
 java.util.Date getDatePlacedInQueue()
          Returns the date when this interaction was last placed into a queue.
 java.util.Date getDateReceived()
          Returns the date when this interaction was received.
 java.lang.String getFrom()
          Returns the e-mail address of the sender of this interaction.
 InteractionMultimedia getInteractionMultimedia()
          Returns the InteractionMultimedia object.
 java.lang.String getInteractionSubType()
          Returns the InteractionSubtype of this interaction.
 java.lang.String getInteractionType()
          Returns the interaction's type name.
 java.lang.String getMediaType()
          Returns the interaction's media type name.
 java.lang.String getParentId()
          Returns the ID of the interaction which is parent of this interaction.
 int getPriority()
          Returns the priority of this interaction.
 java.lang.String getQueue()
          Returns the ID of the Queue where this interaction currently is.
 java.lang.String getSender()
          Returns the sender of this interaction.
 Interaction.Status getStatus()
          Returns the current status of this interaction.
 java.lang.String getSubject()
          Returns the subject of this interaction.
 java.lang.String getTo()
          Returns the e-mail address of the recipient of this interaction.
 Interaction.Type getType()
          Returns the type of this interaction.
 java.lang.String getWorkbinName()
          Returns the name of the workbin in which this interaction currently is, or null if this interaction is not in a workbin.
 java.lang.String getWorkbinOwner()
          Returns the name of the owner of this interaction, or null if it is not currently in a workbin.
 boolean isOnline()
          Returns true if the media of this interaction is a connected media.
 InteractionMultimedia pullInteractionMultimedia(Place place)
          Requests the opening of this interaction for the agent logged on this Place.
 
Methods inherited from interface com.genesyslab.ail.IdObject
getId, getObjectType
 

Method Detail

getSender

java.lang.String getSender()
Returns the sender of this interaction.


getSubject

java.lang.String getSubject()
Returns the subject of this interaction.


getInteractionMultimedia

InteractionMultimedia getInteractionMultimedia()
                                               throws RequestFailedException
Returns the InteractionMultimedia object. This object can be actually handled by an agent.

Throws:
RequestFailedException

getContactServerId

java.lang.String getContactServerId()
Returns the ID of this interaction in the Contact Server. It is also called DBID.

Note: If the DATABASE service is not available, that is, if Universal Contact Server (UCS) is not connected, do not call this method.


getParentId

java.lang.String getParentId()
Returns the ID of the interaction which is parent of this interaction. An interaction is the child of another interaction if it was composed as an answer to it.


getType

Interaction.Type getType()
Returns the type of this interaction.


getMediaType

java.lang.String getMediaType()
Returns the interaction's media type name.

Since:
7.6.1

getInteractionType

java.lang.String getInteractionType()
Returns the interaction's type name.

Since:
7.6.1

getInteractionSubType

java.lang.String getInteractionSubType()
Returns the InteractionSubtype of this interaction.

Since:
7.6.1

isOnline

boolean isOnline()
Returns true if the media of this interaction is a connected media.


getPriority

int getPriority()
Returns the priority of this interaction.


getStatus

Interaction.Status getStatus()
Returns the current status of this interaction.


getQueue

java.lang.String getQueue()
Returns the ID of the Queue where this interaction currently is. Queue is null for history interactions.


getDateReceived

java.util.Date getDateReceived()
Returns the date when this interaction was received.

Returns:
null if this interaction was not received yet (a draft e-mail for example).

getDateDelivered

java.util.Date getDateDelivered()
Returns the date when this interaction was delivered.

Returns:
null if this interaction was not delivered yet (a draft e-mail for example).

getDatePlacedInQueue

java.util.Date getDatePlacedInQueue()
Returns the date when this interaction was last placed into a queue.


getContactId

java.lang.String getContactId()
Returns the ID of the contact of this interaction.

Note: If the DATABASE service is not available, that is, if Universal Contact Server (UCS) is not connected, do not use this ID.


getCaseId

java.lang.String getCaseId()
Returns the ID of the case of this interaction.


getFrom

java.lang.String getFrom()
Returns the e-mail address of the sender of this interaction. This should be null for non e-mail interactions.


getTo

java.lang.String getTo()
Returns the e-mail address of the recipient of this interaction. This should be null for non e-mail interactions.


getAttachedData

java.util.Map getAttachedData()
Returns the attached data of this interaction. The keys of this Map are Strings. See AbstractInteraction.setAttachedData(String, Object) for the type of objects you may expect in the returned Map.


getWorkbinName

java.lang.String getWorkbinName()
Returns the name of the workbin in which this interaction currently is, or null if this interaction is not in a workbin.


getWorkbinOwner

java.lang.String getWorkbinOwner()
Returns the name of the owner of this interaction, or null if it is not currently in a workbin. The owner id is the employeeId if this is an agent workbin, the place ID in a Place Workbin or the group name in a group workbin (place group or agent group).


pullInteractionMultimedia

InteractionMultimedia pullInteractionMultimedia(Place place)
                                                throws RequestFailedException
Requests the opening of this interaction for the agent logged on this Place.

Parameters:
place - the Place onto which the interaction must be opened.
Throws:
RequestFailedException