|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface Interaction
Representation of an interaction in the Agent Interaction Layer.
| Nested Class Summary | |
|---|---|
static class |
Interaction.Action
Constants for the possible actions on interactions, common for all media. |
static class |
Interaction.Status
Constants for interaction statuses, common for all media. |
static class |
Interaction.Type
Constants that describe the possible types of interactions. |
| Nested classes/interfaces inherited from interface com.genesyslab.ail.AbstractInteraction |
|---|
AbstractInteraction.AbstractCallType |
| Method Summary | |
|---|---|
void |
answerCall(java.util.Map reasons)
Answers this Interaction. |
int |
countOtherPendingInteractions()
Returns the number of pending interactions for this contact. |
java.lang.String |
getContactId()
Returns the ID of this interaction's Contact. |
byte[] |
getContentBinary()
Returns the interaction's binary content. |
java.lang.String |
getContentBinaryMimeType()
Returns the MIME type that identifies the format of the interaction's binary contents. |
int |
getContentBinarySize()
Returns the size of interaction's binary content. |
java.util.Date |
getDateCreated()
Returns the date when this Interaction was created. |
Dn |
getDn()
Deprecated. since 7.0. Use InteractionVoice.getDn() for voice interactions. |
java.util.Date |
getEndDate()
Returns the date when the Interaction processing was over. |
MediaType |
getMedia()
Returns the media of this interaction. |
java.lang.String |
getNotepad()
Returns the notepad (comment) of this interaction. |
Interaction |
getParentInteraction()
Returns the Interaction to which this one replies. |
Place |
getPlace()
Returns the Place to which this interaction is bound, or null if no |
java.lang.String |
getQueue()
Returns the ID of the queue in which this Interaction currently is. |
Interaction.Status |
getStatus()
Returns the current status of this interaction. |
java.lang.String |
getStructTextMimeType()
Returns The MIME type of the structured text. |
java.lang.String |
getStructuredText()
Returns the structured text of the interaction. |
java.lang.String |
getSubject()
Returns the subject of this interaction. |
java.lang.String |
getText()
Returns the displayable text of the interaction, without any structure or format information. |
Interaction.Type |
getType()
Returns the type of this interaction. |
java.lang.String |
getUserName()
Returns the user name of the agent who has processed this interaction. |
boolean |
isDone()
Returns true if the Interaction has been marked as terminated. |
void |
markDone()
Marks this Interaction as done. |
void |
merge(java.lang.String contact_id,
boolean all)
Moves this Interaction into the History of another Contact. |
void |
releaseCall(java.util.Map reasons)
Releases this Interaction. |
void |
save()
Saves this interaction into the Contact Server. |
void |
setContactId(java.lang.String id)
Sets the Contact of this Interaction. |
void |
setContentBinary(byte[] content)
Sets the interaction's binary content. |
void |
setContentBinaryMimeType(java.lang.String mime_type)
Sets the MIME type that identifies the format of the interaction's binary content. |
void |
setContentBinarySize(int size)
Sets the size of interaction's binary content. |
void |
setNotepad(java.lang.String notepad)
Sets the notepad (comment) of this interaction. |
void |
setStructTextMimeType(java.lang.String mime_type)
Sets the MIME type of the StructuredText field. |
void |
setStructuredText(java.lang.String structured_text)
Sets the structured text of the interaction. |
void |
setSubject(java.lang.String subject)
Sets the subject of this interaction. |
void |
setText(java.lang.String text)
Sets the displayable text of the interaction. |
| Methods inherited from interface com.genesyslab.ail.AbstractInteraction |
|---|
addInteractionListener, getAttachedData, getAttachedData, getAttachedDataEx, getTConnectionId, queryStatus, removeAttachedData, removeInteractionListener, saveAttachedData, setAttachedData, setAttachedData |
| Methods inherited from interface com.genesyslab.ail.Possible |
|---|
arePossible, isPossible |
| Methods inherited from interface com.genesyslab.ail.Savable |
|---|
getContactServerId, isDirty |
| Method Detail |
|---|
void save()
throws RequestFailedException
save in interface SavableDatabaseServiceException - if there is a problem with the Contact Server.
RequestFailedException
void merge(java.lang.String contact_id,
boolean all)
throws RequestFailedException
Interaction into the History of another Contact. This is useful if an agent discovers that the Contact whom this
Interaction is affected is wrong or exists another time elsewhere in the contact
database, the agent may want to merge this Interaction into the
History of the correct Contact. The agent may also want to merge all
Interactions that were mis-applied to this Contact into the
History of the correct Contact.
Note: If the DATABASE service is not available, that is, if Universal Contact Server (UCS)
is not connected, do not call this method.
contact_id - the contact. This Interaction must be merged into this contact's History.all - If true, merges also all the other Interactions of the same source
Contact into the History of the contact specified in parameter.
RequestFailedExceptionDn getDn()
InteractionVoice.getDn() for voice interactions.
Dn on which this interaction is
bound. This method is only valid for voice interactions.
null for multimedia interactions.Interaction.Status getStatus()
MediaType getMedia()
MediaType.VOICE, but on a SIP Server, the media can
also be MediaType.CHAT.
Interaction.Type getType()
int countOtherPendingInteractions()
throws RequestFailedException
Interaction.
Note: If the DATABASE service is not available, that is, if Universal Contact Server (UCS)
is not connected, do not call this method.
RequestFailedExceptionjava.lang.String getQueue()
Interaction currently is.
boolean isDone()
throws RequestFailedException
true if the Interaction has been marked as terminated.
RequestFailedExceptionjava.util.Date getDateCreated()
Interaction was created.
java.util.Date getEndDate()
Interaction processing was over. This can be the date
when an agent has marked the Interaction as done.
void setContactId(java.lang.String id)
throws RequestFailedException
Contact of this Interaction. You should call this method after you have
created a new e-mail with Place.createInteraction()
id - The id of the Contact.
RequestFailedExceptionjava.lang.String getContactId()
Contact. You can get the Contact
object with ContactManager.getContact(String)
java.lang.String getUserName()
java.lang.String getNotepad()
throws RequestFailedException
RequestFailedException
void setNotepad(java.lang.String notepad)
throws RequestFailedException
RequestFailedExceptionjava.lang.String getSubject()
void setSubject(java.lang.String subject)
throws RequestFailedException
RequestFailedExceptionjava.lang.String getText()
getStructuredText()
void setText(java.lang.String text)
throws RequestFailedException
RequestFailedExceptiongetText()java.lang.String getStructTextMimeType()
getStructuredText()
void setStructTextMimeType(java.lang.String mime_type)
throws RequestFailedException
RequestFailedExceptionsetStructuredText(java.lang.String)java.lang.String getStructuredText()
getStructTextMimeType()
void setStructuredText(java.lang.String structured_text)
throws RequestFailedException
RequestFailedExceptionsetStructTextMimeType(java.lang.String)
void answerCall(java.util.Map reasons)
throws RequestFailedException
Interaction. This method must be used to answer a call that is in
'RINGING' status and have it switch into 'TALKING' status.
reasons - reasons specified by this agent for answering this Interaction.
RequestFailedException
void releaseCall(java.util.Map reasons)
throws RequestFailedException
Interaction.
reasons - reasons specified by this agent for releasing this Interaction.
RequestFailedException
void markDone()
throws RequestFailedException
Interaction as done.
RequestFailedExceptionInteraction getParentInteraction()
Interaction to which this one replies. Can be null if
this Interaction does not reply to another.
Note: If the DATABASE service is not available, that is, if Universal Contact Server (UCS)
is not connected, do not call this method.
byte[] getContentBinary()
int getContentBinarySize()
java.lang.String getContentBinaryMimeType()
getContentBinary()
void setContentBinary(byte[] content)
throws RequestFailedException
content - the byte array of the content.
RequestFailedException.
RequestFailedException
void setContentBinarySize(int size)
throws RequestFailedException
size - the size of the content.
RequestFailedException.
RequestFailedException
void setContentBinaryMimeType(java.lang.String mime_type)
throws RequestFailedException
mime_type - the MIME type of the content.
RequestFailedException.
RequestFailedExceptionPlace getPlace()
Place to which this interaction is bound, or null if no
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||