com.genesyslab.ail.srl
Interface StandardResponse

All Superinterfaces:
IdObject

public interface StandardResponse
extends IdObject

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

getName

java.lang.String getName()
Returns the name of this StandardResponse.

Returns:
the String name.

getBody

java.lang.String getBody()
Returns the body text of this StandardResponse.

The returned text contains field codes that are not replaced with their values.

Returns:
the body as a String.

getBody

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.

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.

Parameters:
agent - the Agent involved.
interaction - the Interaction. This can be an InteractionMailOut or an InteractionChat.
Returns:
the body text, as a String.

getBody

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.

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.

Parameters:
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.
Returns:
the body text as a String.

hasAttachments

boolean hasAttachments()
Returns true if this StandardResponse has attached files.

Returns:
true if attachements exist.

getAttachments

java.util.Collection<Attachment> getAttachments()
Returns the files attached to this StandardResponse as a Collection of Attachments.

Returns:
Collection of Attachment.

getAttachment

Attachment getAttachment(java.lang.String id)
Returns the attached file as an Attachment.

Parameters:
id - identifier of the attachment.

getDescription

java.lang.String getDescription()
Returns the description of this StandardResponse as a String.

Returns:
the String description.

getAgentDesktopUsageType

StandardResponse.UsageType getAgentDesktopUsageType()
Returns the Agent Desktop usage type of this StandardResponse as a StandardResponse.UsageType.

Returns:
an Agent Desktop usage type as UsageType.

getLang

java.lang.String getLang()
Returns the language of this StandardResponse as a String.

Returns:
language as String

getCategoryId

java.lang.String getCategoryId()
Returns the category identifier of this StandardResponse as a String.

Returns:
a category identifier as String.

getStructuredBody

java.lang.String getStructuredBody()
Returns the structured body of the 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.

Returns:
the body, as a String.

getStructBodyMimeType

java.lang.String getStructBodyMimeType()
Returns the MIME type of the structured body. Complies with rules described in RFC 2046.

The text returned by calling getStructuredBody() depends on this MIME type.


getStructuredBody

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.

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.

Parameters:
agent - the Agent involved.
interaction - the Interaction involved. This can be an InteractionMailOut or an InteractionChat.
Returns:
the structured body, as a String.

getStructuredBody

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.

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.

Parameters:
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.
Returns:
the structured body, as a String.

getCustomFieldCodes

java.util.Collection getCustomFieldCodes()
Returns custom field codes as a Collection of String.


getSubject

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


getExpirationDate

java.util.Date getExpirationDate()
Returns date when this Standard Response expires, or null if this Standard Response never expires.