|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Represents an MIL interaction.
To get an instance of this class, call the
MILInteractionManager.createInteraction()
as shown in the following code snippet:
MILInteraction myInteraction =
isManager.createInteraction("Inbound", //interaction type
"InboundNew", //interaction subtype
"ThirdPartyMedia"); //media type
Then, set the queue name to which the interaction is submitted, and other properties such
as MILISInteractionParameters and MILUCSInteractionParameters parameters
that you can use to attach data to the interaction.
To submit the interaction to Interaction Server, call the
MILInteractionManager.submit(MILInteraction) method.
If you add MILISInteractionParameters to the interaction, those
are submitted to Interaction Server with the interaction.
Before or after submitting the interaction to the Interaction Manager,
you can save the MILInteraction in UCS
by calling the MILUCSManager.saveInteraction() method.
Once the interaction is saved in UCS, you can retrieve it using the MILUCSManager.
If the interaction data changes, save the interaction to update it in UCS.
Note: MILISInteractionParameters are not saved in UCS.
Only MILUCSInteractionParameters are saved with the interaction in UCS.
| Method Summary | |
java.lang.String |
getExternalID()
Gets reference identifier that can be used by external system This MUST NOT be used to reference enteties from other enteties (the ID attribute is used for that) |
java.lang.String |
getID()
Returns the interaction ID. |
MILISInteractionParameters |
getISParameters()
Returns the Interaction Server interaction parameters. |
java.lang.String |
getMediaType()
Returns the interaction media type. |
java.lang.String |
getParentID()
Returns the ID of the associated parent interaction in UCS. |
int |
getPriority()
|
java.lang.String |
getQueueName()
Returns the name of the queue to which this interaction belongs (that is, will belong). |
java.util.Date |
getReceivedAt()
Returns the date when the interaction was received. |
java.lang.String |
getSubtype()
Returns the interaction subtype. |
java.lang.String |
getType()
Returns the interaction type. |
MILUCSInteractionParameters |
getUCSParameters()
Returns the UCS interaction parameters. |
void |
setExternalID(java.lang.String externalID)
Sets reference identifier that can be used or set by external system |
void |
setID(java.lang.String id)
Sets this interaction's ID. |
void |
setMediaType(java.lang.String mediaType)
Sets the interaction media type. |
void |
setParentID(java.lang.String parentID)
Sets the ID of the associated parent interaction in UCS. |
void |
setPriorty(int priority)
|
void |
setQueueName(java.lang.String queueName)
Sets the name of the queue to which this interaction belongs (that is, will belong). |
void |
setReceivedAt(java.util.Date receivedAt)
Sets the date when the interaction was received. |
void |
setSubtype(java.lang.String subType)
Sets the interaction subtype. |
void |
setType(java.lang.String type)
Sets the interaction type. |
| Method Detail |
public java.lang.String getID()
null at interaction creation.
public MILISInteractionParameters getISParameters()
These parameters do not persist in UCS.
public java.lang.String getMediaType()
This is a mandatory parameter for submitting the MILInteraction.
public java.lang.String getQueueName()
public java.util.Date getReceivedAt()
public java.lang.String getSubtype()
This is a mandatory parameter for submitting the MILInteraction.
public java.lang.String getType()
The interaction type is a mandatory parameter for submitting the MILInteraction.
public MILUCSInteractionParameters getUCSParameters()
These parameters persist in UCS.
public void setID(java.lang.String id)
id - interaction ID.public void setMediaType(java.lang.String mediaType)
The interaction media type value corresponds to one value
of the Media Type business attribute defined in the Configuration Layer.
This is a mandatory parameter for submitting the MILInteraction.
mediaType - the interaction media type.public void setQueueName(java.lang.String queueName)
The queue name is a mandatory parameter for submitting the MILInteraction.
queueName - a queue name.public void setReceivedAt(java.util.Date receivedAt)
This data persists in UCS only when set before your application first saves this interaction
by calling the MILUCSManager.saveInteraction(MILInteraction) method.
receivedAt - public void setSubtype(java.lang.String subType)
The interaction subtype value corresponds to one value
of the Interaction Subtype business attribute defined in the Configuration Layer.
This is a mandatory parameter for submitting the MILInteraction.
subType - the interaction subtype.public void setType(java.lang.String type)
MILInteraction.
The interaction type value corresponds to one value
of the Interaction Type business attribute defined in the Configuration Layer.
The interaction type is a mandatory parameter for submitting the MILInteraction.
type - the interaction type.public java.lang.String getParentID()
public int getPriority()
public void setPriorty(int priority)
public void setParentID(java.lang.String parentID)
parentID - parent interaction ID.public java.lang.String getExternalID()
public void setExternalID(java.lang.String externalID)
externalID -
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||