curam.util.workflow.impl

Class EnactmentService

java.lang.Object

curam.util.workflow.impl.EnactmentService

@AccessLevel(value=EXTERNAL)
public final class EnactmentService
extends java.lang.Object

Provides facilities for application code to enact workflows. If enactment mappings are specified for the process to be enacted, then a list of Curam structs is passed that provide the data to satisfy the required enactment data specified by the process definition enactment mappings.

The startProcess method maps the data passed in to the relevant workflow data objects and then sends a message to start the process asynchronously. If the structs supplied are insufficient to fully populate the enactment data of the required process the process is not started.

Method Summary

Modifier and Type	Method and Description
static org.w3c.dom.Document	startProcess(org.w3c.dom.Document processEnactmentXML) Start a workflow process from a web service.
static long	startProcess(java.lang.String processName, java.util.List<? extends java.lang.Object> enactmentStructs) Populates the workflow data object attributes required to start the process from the list of structs passed in, then enqueues a message to start the process.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

startProcess

public static long startProcess(java.lang.String processName,
                                java.util.List<? extends java.lang.Object> enactmentStructs)
                         throws curam.util.exception.AppException,
                                curam.util.exception.InformationalException

Populates the workflow data object attributes required to start the process from the list of structs passed in, then enqueues a message to start the process. If insufficient enactment data is passed in or any other errors occur the process is not started.

Parameters:

processName - The name of the workflow process to be enacted. This is the name given to the process when it was defined in the Process Definition Tool (PDT).

enactmentStructs - list of Curam structs containing the process enactment data.

Returns:

The identifier of the newly created process instance.

Throws:

curam.util.exception.AppException - RUN_ID_STARTING_PROCESS_REQUIRED_WDO_ATTRIBUTES_NOT_SET if the Curam structs supplied are not sufficient to start the associated process.

curam.util.exception.InformationalException - Generic Exception Signature.

startProcess

public static org.w3c.dom.Document startProcess(org.w3c.dom.Document processEnactmentXML)
                                         throws curam.util.exception.AppException,
                                                curam.util.exception.InformationalException

Start a workflow process from a web service.

Parameters:

processEnactmentXML - Process enactment data.

Returns:

The enactment confirmation message.

Throws:

curam.util.exception.AppException - RUN_ID_STARTING_PROCESS_REQUIRED_WDO_ATTRIBUTES_NOT_SET if the Curam structs supplied are not sufficient to start the associated process.

curam.util.exception.InformationalException - Generic Exception Signature.