com.genesyslab.omsdk.mil
Interface MILUCSInteractionParameters


public interface MILUCSInteractionParameters

Encapsulates interaction parameters to save in UCS.

To get an instance of this interface, call MILInteraction.getUCSParameters() as shown in the following code snippet.

MILUCSInteractionParameters ucsInteractionParameters
    = milInteraction.getUCSParameters();

Fill in the interaction parameters with the set methods of this interface. Save the interaction by calling the MILUCSManager.saveInteraction() method.

//Setting some application parameters
ucsInteractionParameters.setStatus(MILUCSInteractionStatus.NEW);
ucsInteractionParameters.setProperty("data_name","data_value");
//Performing the first save of the interaction
ucsManager.saveInteraction(milInteraction);

After the first save, to propagate parameter changes in UCS, you can modify interaction parameters and save the interaction again. For instance, the following code snippet shows how to update the interaction status in UCS.

//Updating some application parameters
ucsInteractionParameters.setStatus(MILUCSInteractionStatus.PENDING);

//Performing a new save of the interaction
ucsManager.saveInteraction(milInteraction);

Note: Not all interaction parameters are updated. The following parameters are saved only once, that is, at first save: CanBeParent, DoNotThread,

Since:
7.1.000.00

Method Summary
 java.lang.Boolean getCanBeParent()
          Returns true if this new interaction can have children interactions in UCS.
 java.lang.String getCaseId()
           
 java.lang.String getCategoryId()
           
 java.lang.String getContactId()
           
 byte[] getContentBinary()
          Returns the interaction's binary contents.
 java.lang.Integer getContentBinarySize()
          Returns the size of the interaction's binary contents.
 java.lang.String getContentMimeType()
          Returns the MIME type that identifies the format of the interaction's binary contents.
 java.lang.String getCustomerSegment()
           
 java.lang.Integer getCustomNumber1()
           
 java.lang.Integer getCustomNumber2()
           
 java.lang.Integer getCustomNumber3()
           
 java.lang.String getCustomString1()
           
 java.lang.String getCustomString2()
           
 java.lang.String getCustomString3()
           
 java.lang.String getCustomString4()
           
 java.lang.String getCustomString5()
           
 java.lang.String getCustomString6()
           
 java.lang.String getCustomString7()
           
 java.lang.String getDispositionCode()
           
 java.lang.Boolean getDoNotThread()
          Returns true if threading under another interaction in a UCS contact history is disabled.
 java.lang.String getFromAddress()
           
 java.lang.String getFromPersonal()
           
 java.lang.String getMailbox()
           
 java.lang.String getParentID()
          Deprecated. as 7.2.000.00
 java.util.Map getProperties()
          Returns a read-only Map object containing the UCS properties of the interaction.
 java.lang.Object getProperty(java.lang.String name)
          Returns the specified interaction property.
 java.lang.String getReasonCode()
           
 java.lang.Integer getServiceObjective()
           
 java.lang.String getServiceType()
           
 MILUCSInteractionStatus getStatus()
          Returns the interaction UCS status.
 java.lang.String getStructuredText()
          Contains the structured text of the interaction.
 java.lang.String getStructuredTextMimeType()
          The MIME type of the StructuredText field.
 java.lang.String getSubject()
           
 java.lang.String getText()
          Contains the displayable text of the interaction, without any structure or format information.
 void removeProperty(java.lang.String name)
          Removes the specified interaction property.
 void setCanBeParent(java.lang.Boolean canBeParent)
          Sets whether this new interaction can have children interactions in UCS.
 void setCaseId(java.lang.String value)
           
 void setCategoryId(java.lang.String value)
           
 void setContactId(java.lang.String value)
           
 void setContentBinary(byte[] contentBinary)
          Sets the interaction's binary contents.
 void setContentBinarySize(java.lang.Integer contentBinSize)
          Deprecated. not used anymore, content size is calculated automatically by UCS server
 void setContentMimeType(java.lang.String contentMimeType)
          Sets the MIME type that identifies the format of the interaction's binary content.
 void setCustomerSegment(java.lang.String value)
           
 void setCustomNumber1(java.lang.Integer value)
           
 void setCustomNumber2(java.lang.Integer value)
           
 void setCustomNumber3(java.lang.Integer value)
           
 void setCustomString1(java.lang.String value)
           
 void setCustomString2(java.lang.String value)
           
 void setCustomString3(java.lang.String value)
           
 void setCustomString4(java.lang.String value)
           
 void setCustomString5(java.lang.String value)
           
 void setCustomString6(java.lang.String value)
           
 void setCustomString7(java.lang.String value)
           
 void setDispositionCode(java.lang.String value)
           
 void setDoNotThread(java.lang.Boolean doNotThread)
          Sets whether threading under another interaction in a UCS contact history is disabled.
 void setFromAddress(java.lang.String value)
           
 void setFromPersonal(java.lang.String value)
           
 void setMailbox(java.lang.String value)
           
 void setParentID(java.lang.String parentID)
          Deprecated. as 7.2.000.00
 void setProperties(java.util.Map properties)
          Assigns a new set of interaction properties.
 void setProperty(java.lang.String name, java.lang.Object value)
          Sets the specified interaction property.
 void setReasonCode(java.lang.String value)
           
 void setServiceObjective(java.lang.Integer value)
          Sets the date when the interaction was received.
 void setServiceType(java.lang.String value)
           
 void setStatus(MILUCSInteractionStatus status)
          Sets the UCS status of an interaction.
 void setStructuredText(java.lang.String text)
          Sets StructuredText attribute
 void setStructuredTextMimeType(java.lang.String mimeType)
          Sets StructuredTextMimeType attribute
 void setSubject(java.lang.String value)
           
 void setText(java.lang.String text)
          Sets Text attribute
 

Method Detail

getProperties

public java.util.Map getProperties()
Returns a read-only Map object containing the UCS properties of the interaction.

Returns:
Map of single-level key-value pairs, where:
  • key is a String for the property name.
  • value is one of the following:
    • Integer
    • String
    • ArrayList of Byte set in the Configuration Layer for this application.

setProperties

public void setProperties(java.util.Map properties)
Assigns a new set of interaction properties.

Prior properties are lost. To change existing properties, use setProperty(String, Object ) instead.

Parameters:
properties - Map of single-level key-value pairs, where:
  • key is a String for the property name.
  • value is one of the following:
    • Integer
    • String
    • ArrayList of Byte, set in the Configuration Layer for this application.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
Sets the specified interaction property.

Parameters:
name - property name.
value - property value, that is:
  • Integer
  • String
  • ArrayList of Byte, set in the Configuration Layer for this application.

getProperty

public java.lang.Object getProperty(java.lang.String name)
Returns the specified interaction property.

Parameters:
name - property name.
Returns:
property value, that is:
  • Integer
  • String
  • ArrayList of Byte, set in the Configuration Layer for this application.

removeProperty

public void removeProperty(java.lang.String name)
Removes the specified interaction property.

Parameters:
name - name of the property to be removed.

getCanBeParent

public java.lang.Boolean getCanBeParent()
Returns true if this new interaction can have children interactions in UCS.

This interaction parameter is optional and is true by default.

Returns:
true if this interaction can have child interactions in UCS; otherwise false.

setCanBeParent

public void setCanBeParent(java.lang.Boolean canBeParent)
Sets whether this new interaction can have children interactions in UCS.

This interaction parameter persists in UCS if you set it before the first save of the interaction in UCS.

This interaction parameter is optional and is true by default.

Parameters:
canBeParent - true if this interaction can have child interactions in UCS; otherwise false.
See Also:
MILUCSManager.saveInteraction(MILInteraction)

getDoNotThread

public java.lang.Boolean getDoNotThread()
Returns true if threading under another interaction in a UCS contact history is disabled.

This interaction parameter is optional and is set to true by default.

Returns:
true if threading under another interaction in a UCS contact history is disabled; otherwise false.

setDoNotThread

public void setDoNotThread(java.lang.Boolean doNotThread)
Sets whether threading under another interaction in a UCS contact history is disabled.

This interaction parameter persists in UCS if you set it before the first save of this interaction in UCS.

This interaction parameter is optional and is set to true by default.

Parameters:
doNotThread - true if threading under another interaction in a UCS contact history is disabled; otherwise false.
See Also:
MILUCSManager.saveInteraction(MILInteraction)

getStatus

public MILUCSInteractionStatus getStatus()
Returns the interaction UCS status.

Returns:
the interaction UCS status; otherwise, MILUCSInteractionStatus.UNKNOWN if MIL cannot determine the status.

setStatus

public void setStatus(MILUCSInteractionStatus status)
Sets the UCS status of an interaction.

To modify the interaction status in UCS:

Parameters:
status - status; when it is set to UNKNOWN, the status is not updated in UCS.
See Also:
MILUCSInteractionParameters

getContentBinary

public byte[] getContentBinary()
Returns the interaction's binary contents.

To get the associated MIME type, call setContentMimeType(java.lang.String).

Returns:
the interaction's binary contents.

setContentBinary

public void setContentBinary(byte[] contentBinary)
Sets the interaction's binary contents.

If you set interaction binary contents, specify the associated MIME type and binary size.

Parameters:
contentBinary - the interaction's binary contents.
See Also:
setContentMimeType(java.lang.String), setContentBinarySize(java.lang.Integer)

getContentMimeType

public java.lang.String getContentMimeType()
Returns the MIME type that identifies the format of the interaction's binary contents.

Returns:
the MIME type of interaction binary contents (compliant with RFC 2046 standards.)

setContentMimeType

public void setContentMimeType(java.lang.String contentMimeType)
Sets the MIME type that identifies the format of the interaction's binary content.

This MIME type has to be compliant with RFC 2046 standards.

If you set binary contents for this interaction, set this parameter with a non-null value.

Parameters:
contentMimeType - the MIME type of interaction binary contents (compliant with RFC 2046 standards.)
See Also:
setContentBinary(byte[])

getContentBinarySize

public java.lang.Integer getContentBinarySize()
Returns the size of the interaction's binary contents.

Returns:
the size of interaction's binary contents; or null if the interaction has no binary contents.

setContentBinarySize

public void setContentBinarySize(java.lang.Integer contentBinSize)
Deprecated. not used anymore, content size is calculated automatically by UCS server

Sets the size of the interaction's binary contents.

Cannot be null if binary contents are set for this interaction.

Parameters:
contentBinSize - the size of the interaction's binary contents.
See Also:
setContentBinary(byte[])

getText

public java.lang.String getText()
Contains the displayable text of the interaction, without any structure or format information. To get the structured text, the "StructuredText" item can be used. It allows easy access to the interaction information. For emails, it's the plain text body (if any). For chat, it's the text version of the transcript. For Cobrowse, it might include all the hyperlinks which have been cobrowsed. Not applicable for voice, or maybe it to store VSS info to display.

Returns:
Text attribute

setText

public void setText(java.lang.String text)
Sets Text attribute

Parameters:
text -

setStructuredText

public void setStructuredText(java.lang.String text)
Sets StructuredText attribute

Parameters:
text -

getStructuredText

public java.lang.String getStructuredText()
Contains the structured text of the interaction. It allows easy access to the structured interaction information. For email where body is HTML formatted, it's the HTML body. For chat transcript, it's a somehow formatted version of the transcript. For Cobrowse, it might include all the hyperlinks which have been cobrowsed. Not applicable for voice, or maybe it to store VSS info to display.

Returns:
StructiredText attribute

setStructuredTextMimeType

public void setStructuredTextMimeType(java.lang.String mimeType)
Sets StructuredTextMimeType attribute

Parameters:
mimeType -

getStructuredTextMimeType

public java.lang.String getStructuredTextMimeType()
The MIME type of the StructuredText field. Must comply with rules described in RFC 2046.

Returns:
StructuredTextMimeType attribute

getParentID

public java.lang.String getParentID()
Deprecated. as 7.2.000.00

Returns the ID of the associated parent interaction in UCS.

Returns:
parent interaction ID.

setParentID

public void setParentID(java.lang.String parentID)
Deprecated. as 7.2.000.00

Sets the ID of the associated parent interaction in UCS.

Parameters:
parentID - parent interaction ID.

getCaseId

public java.lang.String getCaseId()

getCategoryId

public java.lang.String getCategoryId()

getContactId

public java.lang.String getContactId()

getCustomerSegment

public java.lang.String getCustomerSegment()

getCustomNumber1

public java.lang.Integer getCustomNumber1()

getCustomNumber2

public java.lang.Integer getCustomNumber2()

getCustomNumber3

public java.lang.Integer getCustomNumber3()

getCustomString1

public java.lang.String getCustomString1()

getCustomString2

public java.lang.String getCustomString2()

getCustomString3

public java.lang.String getCustomString3()

getCustomString4

public java.lang.String getCustomString4()

getCustomString5

public java.lang.String getCustomString5()

getCustomString6

public java.lang.String getCustomString6()

getCustomString7

public java.lang.String getCustomString7()

getDispositionCode

public java.lang.String getDispositionCode()

getFromAddress

public java.lang.String getFromAddress()

getFromPersonal

public java.lang.String getFromPersonal()

getMailbox

public java.lang.String getMailbox()

getReasonCode

public java.lang.String getReasonCode()

getServiceObjective

public java.lang.Integer getServiceObjective()

getServiceType

public java.lang.String getServiceType()

getSubject

public java.lang.String getSubject()

setCaseId

public void setCaseId(java.lang.String value)

setCategoryId

public void setCategoryId(java.lang.String value)

setContactId

public void setContactId(java.lang.String value)

setCustomerSegment

public void setCustomerSegment(java.lang.String value)

setCustomNumber1

public void setCustomNumber1(java.lang.Integer value)

setCustomNumber2

public void setCustomNumber2(java.lang.Integer value)

setCustomNumber3

public void setCustomNumber3(java.lang.Integer value)

setCustomString1

public void setCustomString1(java.lang.String value)

setCustomString2

public void setCustomString2(java.lang.String value)

setCustomString3

public void setCustomString3(java.lang.String value)

setCustomString4

public void setCustomString4(java.lang.String value)

setCustomString5

public void setCustomString5(java.lang.String value)

setCustomString6

public void setCustomString6(java.lang.String value)

setCustomString7

public void setCustomString7(java.lang.String value)

setDispositionCode

public void setDispositionCode(java.lang.String value)

setFromAddress

public void setFromAddress(java.lang.String value)

setFromPersonal

public void setFromPersonal(java.lang.String value)

setMailbox

public void setMailbox(java.lang.String value)

setReasonCode

public void setReasonCode(java.lang.String value)

setServiceObjective

public void setServiceObjective(java.lang.Integer value)
Sets the date when the interaction was received.

Parameters:
value -

setServiceType

public void setServiceType(java.lang.String value)

setSubject

public void setSubject(java.lang.String value)