com.genesyslab.omsdk.mil
Interface MILInteraction


public interface MILInteraction

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.

Since:
7.1.000.000

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

getID

public java.lang.String getID()
Returns the interaction ID.

null at interaction creation.

Returns:
interaction ID.

getISParameters

public MILISInteractionParameters getISParameters()
Returns the Interaction Server interaction parameters.

These parameters do not persist in UCS.

Returns:
the writeable Interaction Server interaction parameters.

getMediaType

public java.lang.String getMediaType()
Returns the interaction media type.

This is a mandatory parameter for submitting the MILInteraction.

Returns:
the media type.

getQueueName

public java.lang.String getQueueName()
Returns the name of the queue to which this interaction belongs (that is, will belong).

Returns:
the queue name.

getReceivedAt

public java.util.Date getReceivedAt()
Returns the date when the interaction was received.

Returns:
date when the interaction was received. Can be null.

getSubtype

public java.lang.String getSubtype()
Returns the interaction subtype.

This is a mandatory parameter for submitting the MILInteraction.

Returns:
the interaction subtype.

getType

public java.lang.String getType()
Returns the interaction type.

The interaction type is a mandatory parameter for submitting the MILInteraction.

Returns:
the interaction type.

getUCSParameters

public MILUCSInteractionParameters getUCSParameters()
Returns the UCS interaction parameters.

These parameters persist in UCS.

Returns:
the writable UCS parameters.

setID

public void setID(java.lang.String id)
Sets this interaction's ID.

Parameters:
id - interaction ID.

setMediaType

public void setMediaType(java.lang.String mediaType)
Sets the interaction media type.

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.

Parameters:
mediaType - the interaction media type.

setQueueName

public void setQueueName(java.lang.String queueName)
Sets the name of the queue to which this interaction belongs (that is, will belong).

The queue name is a mandatory parameter for submitting the MILInteraction.

Parameters:
queueName - a queue name.

setReceivedAt

public void setReceivedAt(java.util.Date receivedAt)
Sets the date when the interaction was received.

This data persists in UCS only when set before your application first saves this interaction by calling the MILUCSManager.saveInteraction(MILInteraction) method.

Parameters:
receivedAt -

setSubtype

public void setSubtype(java.lang.String subType)
Sets the interaction 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.

Parameters:
subType - the interaction subtype.

setType

public void setType(java.lang.String type)
Sets the interaction type. This is a mandatory parameter for submitting the 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.

Parameters:
type - the interaction type.

getParentID

public java.lang.String getParentID()
Returns the ID of the associated parent interaction in UCS.

Returns:
parent interaction ID.

getPriority

public int getPriority()

setPriorty

public void setPriorty(int priority)

setParentID

public void setParentID(java.lang.String parentID)
Sets the ID of the associated parent interaction in UCS.

Parameters:
parentID - parent interaction ID.

getExternalID

public 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)

Returns:
reference identifier

setExternalID

public void setExternalID(java.lang.String externalID)
Sets reference identifier that can be used or set by external system

Parameters:
externalID -