com.genesyslab.openmedia.soa
Interface UCSService

All Superinterfaces:
IService, java.rmi.Remote

public interface UCSService
extends IService

Provides of UCS-related features hat enable your application to save MIL interactions (mil-interaction:* and mil-interaction.ucs:*) before or after their submission. You can also get get or search for Open Media interactions saved in the UCS database, and stop processing or delete MIL interactions saved in the UCS database.


Method Summary
 void deleteInteraction(java.lang.String interactionId)
          Deletes an interaction from UCS.
 java.lang.String[] findPending(UCSFindCondition condition)
          Finds interactions in UCS and returns their IDs.
 MILInteractionDTO[] getInteractionsDTO(java.lang.String[] interactionIds, java.lang.String[] attributes)
          Gets the processed data associated with these interaction IDs from UCS.
 java.lang.String saveInteraction(MILInteractionDTO interaction)
          Saves all data of the specified interaction in UCS, except interaction parameters for Interaction Server.
 void stopProcessing(java.lang.String interactionId, java.lang.String reason)
          Changes the UCS status of an interaction to STOPPED.
 

Method Detail

findPending

public java.lang.String[] findPending(UCSFindCondition condition)
                               throws ServiceException,
                                      java.rmi.RemoteException
Finds interactions in UCS and returns their IDs.

Parameters:
condition - The search condition.
Returns:
Interaction IDs.
Throws:
ServiceException
java.rmi.RemoteException

getInteractionsDTO

public MILInteractionDTO[] getInteractionsDTO(java.lang.String[] interactionIds,
                                              java.lang.String[] attributes)
                                       throws ServiceException,
                                              java.rmi.RemoteException
Gets the processed data associated with these interaction IDs from UCS. For each interaction, you can get from UCS the following attribute values: mil-interaction.ucs:properties, mil-interaction.ucs:contentBinary, mil-interaction.ucs:contentBinarySize, mil-interaction.ucs:contentMimeType, mil-interaction.ucs:contentMimeType, mil-interaction.ucs:status . Other attributes are not available or considered as UNKNOWN.

Parameters:
interactionIds - The IDs of the interactions to be retrieved.
attributes - The attributes Ids to retrieve (mil-interaction:*, mil-interaction.is:*and mil-interaction.ucs:*).
Returns:
Interaction DTO list.
Throws:
ServiceException
java.rmi.RemoteException

deleteInteraction

public void deleteInteraction(java.lang.String interactionId)
                       throws ServiceException,
                              java.rmi.RemoteException
Deletes an interaction from UCS.

Parameters:
interactionId - ID of the interaction to be deleted.
Throws:
ServiceException
java.rmi.RemoteException

saveInteraction

public java.lang.String saveInteraction(MILInteractionDTO interaction)
                                 throws ServiceException,
                                        java.rmi.RemoteException
Saves all data of the specified interaction in UCS, except interaction parameters for Interaction Server. If the interaction was already saved once, or if the interaction was retrieved by calling the getInteractionsDTO() method, only some of the mil-interaction.ucs parameters are saved. If the interaction was neither saved or retrieved, and if you set an ID that already belongs to a UCS interaction, this method throws an exception.

Parameters:
interaction - The interaction data to save (mil-interaction:* and mil-interaction.ucs:*).
Returns:
Interaction IDs.
Throws:
ServiceException
java.rmi.RemoteException

stopProcessing

public void stopProcessing(java.lang.String interactionId,
                           java.lang.String reason)
                    throws ServiceException,
                           java.rmi.RemoteException
Changes the UCS status of an interaction to STOPPED.

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