|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface StandardResponse
A standard response is a pattern used by agent for filling
InteractionMailOut
and/or categorizing InteractionMailIn.
| Nested Class Summary | |
|---|---|
static class |
StandardResponse.UsageType
Constants that describe the type of Agent Desktop Usage. |
| Nested classes/interfaces inherited from interface com.genesyslab.ail.IdObject |
|---|
IdObject.ObjectType |
| Method Summary | |
|---|---|
StandardResponse.UsageType |
getAgentDesktopUsageType()
Returns the Agent Desktop usage type of this StandardResponse
as a StandardResponse.UsageType. |
Attachment |
getAttachment(java.lang.String id)
Returns the attached file as an Attachment. |
java.util.Collection<Attachment> |
getAttachments()
Returns the files attached to this StandardResponse as a Collection of
Attachments. |
java.lang.String |
getBody()
Returns the body text of this StandardResponse. |
java.lang.String |
getBody(Agent agent,
Interaction interaction)
Returns the body text of this StandardResponse,
with the standard field codes replaced by their values, using data
passed in parameters. |
java.lang.String |
getBody(Agent agent,
Interaction interaction,
java.util.Map customFieldCodes)
Returns the body text of this StandardResponse
with all field codes replaced by their values. |
java.lang.String |
getCategoryId()
Returns the category identifier of this StandardResponse as a String. |
java.util.Collection |
getCustomFieldCodes()
Returns custom field codes as a Collection of String. |
java.lang.String |
getDescription()
Returns the description of this StandardResponse as a String. |
java.util.Date |
getExpirationDate()
Returns date when this Standard Response expires, or null if this Standard Response never expires. |
java.lang.String |
getLang()
Returns the language of this StandardResponse as a String. |
java.lang.String |
getName()
Returns the name of this StandardResponse. |
java.lang.String |
getStructBodyMimeType()
Returns the MIME type of the structured body. |
java.lang.String |
getStructuredBody()
Returns the structured body of the StandardResponse. |
java.lang.String |
getStructuredBody(Agent agent,
Interaction interaction)
Returns the structured body text of this StandardResponse,
with the standard field codes replaced by their values. |
java.lang.String |
getStructuredBody(Agent agent,
Interaction interaction,
java.util.Map customFieldCodes)
Returns the structured body text of this StandardResponse,
with all field codes replaced by their values. |
java.lang.String |
getSubject()
Returns the subject of this Standard Response. |
boolean |
hasAttachments()
Returns true if this StandardResponse
has attached files. |
| Methods inherited from interface com.genesyslab.ail.IdObject |
|---|
getId, getObjectType |
| Method Detail |
|---|
java.lang.String getName()
StandardResponse.
String name.java.lang.String getBody()
StandardResponse.
The returned text contains field codes that are not replaced with their values.
String.
java.lang.String getBody(Agent agent,
Interaction interaction)
StandardResponse,
with the standard field codes replaced by their values, using data
passed in parameters.
Dates are formatted in the Locale of the JVM running the application, using a FULL
SimpleDateFormat.
Full names are defined as
"FirstName + ' ' + LastName".
To use your own formatting, call the getBody() method and
take care of field codes' replacement.
Note: Custom field codes are not replaced in the returned text.
agent - the Agent involved.interaction - the Interaction. This can be
an InteractionMailOut or
an InteractionChat.
String.
java.lang.String getBody(Agent agent,
Interaction interaction,
java.util.Map customFieldCodes)
StandardResponse
with all field codes replaced by their values.
Dates are formatted in the Locale of the JVM running the application, using a FULL
SimpleDateFormat.
Full names are defined as
"FirstName + ' ' + LastName".
To use your own formatting, call the getBody() method and
take care of field codes' replacement.
agent - the Agent involved.interaction - the Interaction involved. This can be
an InteractionMailOut or an InteractionChat.customFieldCodes - the relevant Custom Field Codes, as a
Map of String pairs.
String.boolean hasAttachments()
true if this StandardResponse
has attached files.
java.util.Collection<Attachment> getAttachments()
StandardResponse as a Collection of
Attachments.
Attachment.Attachment getAttachment(java.lang.String id)
Attachment.
id - identifier of the attachment.java.lang.String getDescription()
StandardResponse as a String.
String description.StandardResponse.UsageType getAgentDesktopUsageType()
StandardResponse
as a StandardResponse.UsageType.
UsageType.java.lang.String getLang()
StandardResponse as a String.
Stringjava.lang.String getCategoryId()
StandardResponse as a String.
String.java.lang.String getStructuredBody()
StandardResponse.
To determine the type of body returned, test its MIME type by calling
getStructBodyMimeType().
Note: Field codes are not replaced in the returned text.
String.java.lang.String getStructBodyMimeType()
The text returned by calling getStructuredBody()
depends on this MIME type.
java.lang.String getStructuredBody(Agent agent,
Interaction interaction)
StandardResponse,
with the standard field codes replaced by their values.
To determine the type of body returned, test its MIME type by calling
getStructBodyMimeType().
In the returned text, dates are formatted in the Locale of the JVM running the application, using a FULL
SimpleDateFormat.
Full names are defined as
"FirstName + ' ' + LastName".
To use your own formatting, call the getStructuredBody() method and
take care of field codes' replacement.
Note: Custom field codes are not replaced in the returned text.
agent - the Agent involved.interaction - the Interaction involved. This can be an
InteractionMailOut or an
InteractionChat.
String.
java.lang.String getStructuredBody(Agent agent,
Interaction interaction,
java.util.Map customFieldCodes)
StandardResponse,
with all field codes replaced by their values.
To determine the type of body returned, test its MIME type by calling
getStructBodyMimeType().
In the returned text, dates are formatted in the Locale of the JVM running the application, using a FULL
SimpleDateFormat.
Full names are defined as
"FirstName + ' ' + LastName".
To use your own formatting, call the getStructuredBody() method and
take care of field codes' replacement.
agent - the Agent involved.interaction - the Interaction involved.
This can be an InteractionMailOut or an InteractionChat.customFieldCodes - the relevant Custom Field Codes as a
Map of String pairs.
String.java.util.Collection getCustomFieldCodes()
Collection of String.
java.lang.String getSubject()
java.util.Date getExpirationDate()
null if this Standard Response never expires.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||