|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
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,
| 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 |
public java.util.Map getProperties()
Map object containing the UCS properties of the interaction.
Map of single-level key-value pairs, where:
String for the property name.
IntegerStringArrayList of Byte
set in the Configuration Layer for this application.public void setProperties(java.util.Map properties)
Prior properties are lost. To change existing properties, use setProperty(String,
Object ) instead.
properties - Map of single-level key-value pairs, where:
String for the property name.
IntegerStringArrayList of Byte,
set in the Configuration Layer for this application.
public void setProperty(java.lang.String name,
java.lang.Object value)
name - property name.value - property value, that is: IntegerStringArrayList of Byte,
set in the Configuration Layer for this application.public java.lang.Object getProperty(java.lang.String name)
name - property name.
IntegerStringArrayList of Byte,
set in the Configuration Layer for this application.public void removeProperty(java.lang.String name)
name - name of the property to be removed.public java.lang.Boolean getCanBeParent()
true if this new interaction can have children interactions in UCS.
This interaction parameter is optional and is true by default.
true if this interaction can have child interactions in UCS; otherwise false.public void setCanBeParent(java.lang.Boolean canBeParent)
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.
canBeParent - true if this interaction can have child interactions in UCS; otherwise false.MILUCSManager.saveInteraction(MILInteraction)public java.lang.Boolean getDoNotThread()
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.
true if threading under another interaction in a UCS contact history is disabled; otherwise false.public void setDoNotThread(java.lang.Boolean doNotThread)
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.
doNotThread - true if threading under another interaction in a UCS contact
history is disabled; otherwise false.MILUCSManager.saveInteraction(MILInteraction)public MILUCSInteractionStatus getStatus()
MILUCSInteractionStatus.UNKNOWN if MIL cannot determine the status.public void setStatus(MILUCSInteractionStatus status)
To modify the interaction status in UCS:
setStatus() method.MILUCSManager.saveInteraction(MILInteraction) method.
status - status; when it is set to UNKNOWN, the status is not updated in UCS.MILUCSInteractionParameterspublic byte[] getContentBinary()
To get the associated MIME type, call setContentMimeType(java.lang.String).
public void setContentBinary(byte[] contentBinary)
If you set interaction binary contents, specify the associated MIME type and binary size.
contentBinary - the interaction's binary contents.setContentMimeType(java.lang.String),
setContentBinarySize(java.lang.Integer)public java.lang.String getContentMimeType()
public void setContentMimeType(java.lang.String contentMimeType)
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.
contentMimeType - the MIME type of interaction binary contents (compliant with RFC 2046 standards.)setContentBinary(byte[])public java.lang.Integer getContentBinarySize()
public void setContentBinarySize(java.lang.Integer contentBinSize)
Cannot be null if binary contents are set for this interaction.
contentBinSize - the size of the interaction's binary contents.setContentBinary(byte[])public java.lang.String getText()
public void setText(java.lang.String text)
text - public void setStructuredText(java.lang.String text)
text - public java.lang.String getStructuredText()
public void setStructuredTextMimeType(java.lang.String mimeType)
mimeType - public java.lang.String getStructuredTextMimeType()
public java.lang.String getParentID()
public void setParentID(java.lang.String parentID)
parentID - parent interaction ID.public java.lang.String getCaseId()
public java.lang.String getCategoryId()
public java.lang.String getContactId()
public java.lang.String getCustomerSegment()
public java.lang.Integer getCustomNumber1()
public java.lang.Integer getCustomNumber2()
public java.lang.Integer getCustomNumber3()
public java.lang.String getCustomString1()
public java.lang.String getCustomString2()
public java.lang.String getCustomString3()
public java.lang.String getCustomString4()
public java.lang.String getCustomString5()
public java.lang.String getCustomString6()
public java.lang.String getCustomString7()
public java.lang.String getDispositionCode()
public java.lang.String getFromAddress()
public java.lang.String getFromPersonal()
public java.lang.String getMailbox()
public java.lang.String getReasonCode()
public java.lang.Integer getServiceObjective()
public java.lang.String getServiceType()
public java.lang.String getSubject()
public void setCaseId(java.lang.String value)
public void setCategoryId(java.lang.String value)
public void setContactId(java.lang.String value)
public void setCustomerSegment(java.lang.String value)
public void setCustomNumber1(java.lang.Integer value)
public void setCustomNumber2(java.lang.Integer value)
public void setCustomNumber3(java.lang.Integer value)
public void setCustomString1(java.lang.String value)
public void setCustomString2(java.lang.String value)
public void setCustomString3(java.lang.String value)
public void setCustomString4(java.lang.String value)
public void setCustomString5(java.lang.String value)
public void setCustomString6(java.lang.String value)
public void setCustomString7(java.lang.String value)
public void setDispositionCode(java.lang.String value)
public void setFromAddress(java.lang.String value)
public void setFromPersonal(java.lang.String value)
public void setMailbox(java.lang.String value)
public void setReasonCode(java.lang.String value)
public void setServiceObjective(java.lang.Integer value)
value - public void setServiceType(java.lang.String value)
public void setSubject(java.lang.String value)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||