com.genesyslab.openmedia.soa
Interface MILService

All Superinterfaces:
IService, java.rmi.Remote

public interface MILService
extends IService

This service lets your application manage third-party media interactions in the Genesys Framework. Use this service to build your own interaction workflow and manage interaction related information (status, attached data, and so on). As a consequence, when developing your applications, pay attention to interaction data synchronization through servers. Genesys recommends that when your application modifies mil-interaction data, your application should save these modifications in the UCS database, using the UCS service.


Method Summary
 void changeProperties(java.lang.String interactionId, KeyValue[] changedProperties, java.lang.String[] removedProperties)
          Changes the Interaction Server interaction properties of a submitted interaction
 void sendFault(java.lang.String referenceId, int faultCode, java.lang.String faultString)
          Deprecated.  
 void sendFaultString(java.lang.String referenceId, java.lang.String faultCode, java.lang.String faultString)
          Sends a failed response.
 void sendResponse(java.lang.String referenceId, KeyValue[] response, KeyValue[] userData)
          Sends a successful response.
 void stopProcessing(java.lang.String interactionId, OMStopProcessingReason reason)
          Stops processing the specified interaction.
 MILInteractionDTO submitInteraction(java.lang.String interactionId, java.lang.String queueId, java.lang.String type, java.lang.String subtype, java.lang.String mediatype, KeyValue[] interactionData, boolean save, java.lang.String[] attributes)
          Initializes a third-party media interaction with the values specified as arguments, then submits it to Interaction Server.
 

Method Detail

submitInteraction

public MILInteractionDTO submitInteraction(java.lang.String interactionId,
                                           java.lang.String queueId,
                                           java.lang.String type,
                                           java.lang.String subtype,
                                           java.lang.String mediatype,
                                           KeyValue[] interactionData,
                                           boolean save,
                                           java.lang.String[] attributes)
                                    throws ServiceException,
                                           java.rmi.RemoteException
Initializes a third-party media interaction with the values specified as arguments, then submits it to Interaction Server. These parameters are mandatory for submitting the interaction to Interaction Server. If any parameter is null, or if the interaction ID is not unique, submitting this interaction fails and throws an exception.

Parameters:
interactionId - interaction indentifier.
queueId - queue identifier (name).
type - interaction type.
subtype - interaction subtype.
mediatype - interaction mediatype.
interactionData - interaction data (mil-interaction:* and mil-interaction.is:* and mil-interaction.ucs:*).
save - true to save the interaction in UCS.
attributes - the attributes to retrieve (mil-interaction.*:*) if the submission successes.
Returns:
The MIL data for the created interaction.
Throws:
ServiceException
java.rmi.RemoteException

stopProcessing

public void stopProcessing(java.lang.String interactionId,
                           OMStopProcessingReason reason)
                    throws ServiceException,
                           java.rmi.RemoteException
Stops processing the specified interaction.

Parameters:
interactionId - ID of the interaction to be stopped.
reason - The reason for stopping processing.
Throws:
ServiceException
java.rmi.RemoteException

sendResponse

public void sendResponse(java.lang.String referenceId,
                         KeyValue[] response,
                         KeyValue[] userData)
                  throws ServiceException,
                         java.rmi.RemoteException
Sends a successful response. You can send this response to Interaction Server as a result of processing a CallbackEvent.

Parameters:
referenceId - The reference identifier.
response - The response data.
userData - The response user data.
Throws:
ServiceException
java.rmi.RemoteException

sendFault

public void sendFault(java.lang.String referenceId,
                      int faultCode,
                      java.lang.String faultString)
               throws ServiceException,
                      java.rmi.RemoteException
Deprecated.  

Sends a failed response. You can send this fault response to the Interaction Server as the result of processing a CallbackEvent. This method is deprecated, use sendFaultString instead.

Parameters:
referenceId - The reference identifier.
faultCode - The user-defined error code.
faultString - The user-defined error string.
Throws:
ServiceException
java.rmi.RemoteException

sendFaultString

public void sendFaultString(java.lang.String referenceId,
                            java.lang.String faultCode,
                            java.lang.String faultString)
                     throws ServiceException,
                            java.rmi.RemoteException
Sends a failed response. You can send this fault response to the Interaction Server as the result of processing a CallbackEvent.

Parameters:
referenceId - The reference identifier.
faultCode - The user-defined error code.
faultString - The user-defined error string.
Throws:
ServiceException
java.rmi.RemoteException

changeProperties

public void changeProperties(java.lang.String interactionId,
                             KeyValue[] changedProperties,
                             java.lang.String[] removedProperties)
                      throws ServiceException,
                             java.rmi.RemoteException
Changes the Interaction Server interaction properties of a submitted interaction

Parameters:
interactionId - The interaction identifier whose properties should be changed.
changedProperties - The list of properties to be and/or changed.
removedProperties - The key list of properties to be removed.
Throws:
ServiceException
java.rmi.RemoteException