com.whitestein.lsps.engine

Interface ProcessService

All Known Subinterfaces:

ProcessServiceLocal, ProcessServiceRemote

All Known Implementing Classes:

ProcessServiceBean

public interface ProcessService

Service for accessing and manipulating process execution information.

Author:

rba

Method Summary

Modifier and Type	Method and Description
ExecutionTrace	createAndStartModelInstance(long modelId, StringProperties properties, boolean synchronously, boolean startInterpretation) Creates new model instance for given model id and properties and possibly starts the model instance interpretation, This can be done either synchronously or asynchronously.
ExecutionTrace	createAndStartModelInstanceWithParent(long modelId, StringProperties properties, Long parentModelInstanceId, boolean synchronously, boolean startInterpretation) Creates new model instance for given model id and properties and possibly starts the model instance interpretation, This can be done either synchronously or asynchronously.
ExecutionTrace	createModelInstance(long modelId, StringProperties properties, boolean synchronously) Creates new model instance for given model id and properties.
Long	createModelInstanceSimple(long modelId, StringProperties properties, boolean synchronously) Creates new model instance for given model id and properties.
ModelInstanceInfoList	findModelInstances(ModelInstanceCriteria criteria) Returns model instance info-s according to the provided criteria.
CompressedModelInstance	getCompressedModelInstance(long modelInstanceId) Returns a compressed model instance execution state for given model instance* id or null if it does not exist.
CompressedString	getCompressedModelInstanceXml(long modelInstanceId, List<ModelInstanceData> data) Returns the specified model instance as an xml structure or null if it does not exist.
CompressedData	getCompressedRawModelInstanceXml(long modelInstanceId) Returns the specified model instance as an xml structure or null if it does not exist.
ModelInstance	getModelInstance(long modelInstanceId) Returns complete model instance execution state for given model instance id or null if it does not exist.
ModelInstanceInfo	getModelInstanceInfo(long modelInstanceId) Returns model instance info for given model instance id or null if it does not exist.
String	getModelInstanceXml(long modelInstanceId, List<ModelInstanceData> data) Returns the specified model instance as an xml structure or null if it does not exist.
ByteData	getRawModelInstanceXml(long modelInstanceId) Returns the specified model instance as an xml structure or null if it does not exist.
void	notifyModelInstance(long modelInstanceId, String reason, boolean synchronously) Notifies a model instance.
void	notifyTask(long modelInstanceId, long taskId, String reason, boolean synchronously) Notifies a task in model instance.
void	removeAllFormPreviewModelInstances() Removes all model instances created by form preview.
void	removeSignalFromModelInstance(long modelInstanceId, long signalId, boolean synchronously) Removes a signal from a running model instance.
ExternalRecordValue	resolveReference(long modelInstanceId, ExternalRecordValue value) Resolves external record value reference to a value, attributes of which are populated.
void	restartModelInstances(Collection<Long> modelInstanceIds, long newModuleId) Restarts model instances with new model.
void	resumeModelInstance(long modelInstanceId, boolean synchronously) Resumes model instance execution.
ExecutionTrace	sendSignalToModelInstance(long modelInstanceId, ObjectValue signal, boolean synchronously) Sends a signal to a running model instance.
void	setCompressedRawModelInstanceXml(long modelInstanceId, CompressedData data) Sets the model instance state.
void	setRawModelInstanceXml(long modelInstanceId, ByteData data) Sets the model instance state.
ExecutionTrace	startInterpretModelInstance(long modelInstanceId, boolean synchronously) Starts the interpretation of an existing model instance for given model instance id.
List<Long>	startInterpretModelInstanceSimple(long modelInstanceId, boolean synchronously) Starts the interpretation of an existing model instance for given model instance id.
void	suspendModelInstance(long modelInstanceId, boolean synchronously) Suspends model instance execution.
ExecutionTrace	terminateModelInstance(long modelInstanceId, boolean synchronously) Terminates model instance for given model instance id.
void	updateContextVariable(long modelInstanceId, long contextId, String variable, ObjectValue value, boolean synchronously) Updates the value of a given variable.
void	updateGoalState(long modelInstanceId, long processInstanceId, String goalName, boolean reactivate, boolean synchronously) Changes the state of the given goal.
void	updateRecordField(long modelInstanceId, String recordType, String recordId, String field, ObjectValue value, boolean synchronously) Updates the value of a given record field.

Method Detail

getModelInstance

ModelInstance getModelInstance(long modelInstanceId)

Returns complete model instance execution state for given model instance id or null if it does not exist. The state does not contain BPMN transactions.

Parameters:

modelInstanceId -

Returns:

model instance execution state

getModelInstanceInfo

ModelInstanceInfo getModelInstanceInfo(long modelInstanceId)

Returns model instance info for given model instance id or null if it does not exist.

Parameters:

modelInstanceId - process id

Returns:

process info for given model instance id

getCompressedModelInstance

CompressedModelInstance getCompressedModelInstance(long modelInstanceId)

Returns a compressed model instance execution state for given model instance* id or null if it does not exist. The state does not contain BPMN transactions.

Use this method when transferring large model instance states over the network.

Parameters:

modelInstanceId -

Returns:

a compressed model instance execution state

findModelInstances

ModelInstanceInfoList findModelInstances(ModelInstanceCriteria criteria)

Returns model instance info-s according to the provided criteria. The list is ordered by id. The model instance info-s have no informations about the model instance model.

Parameters:

criteria - criteria for searching

Returns:

collection of ModelInstanceInfos

createModelInstance

ExecutionTrace createModelInstance(long modelId,
                                   StringProperties properties,
                                   boolean synchronously)
                            throws ModuleNotFoundException

Creates new model instance for given model id and properties. This does not start the model instance interpretation, only creates the model instance. To start the interpretation see startInterpretModelInstance(long, boolean). This can be done either synchronously or asynchronously. If asynchronously, the returned ModelInstanceInfo will not contain the model instance id (the id will be -1).

Parameters:

modelId -

properties -

synchronously -

Returns:

execution trace

Throws:

ModuleNotFoundException - if no model exists for the given model id

createModelInstanceSimple

Long createModelInstanceSimple(long modelId,
                               StringProperties properties,
                               boolean synchronously)
                        throws ModuleNotFoundException

Creates new model instance for given model id and properties. This does not start the model instance interpretation, only creates the model instance. To start the interpretation see startInterpretModelInstance(long, boolean). This can be done either synchronously or asynchronously. If asynchronously, the returned ModelInstanceInfo will not contain the model instance id (the id will be -1).

Parameters:

modelId -

properties -

synchronously -

Returns:

List of model instances

Throws:

ModuleNotFoundException - if no model exists for the given model id

createAndStartModelInstance

ExecutionTrace createAndStartModelInstance(long modelId,
                                           StringProperties properties,
                                           boolean synchronously,
                                           boolean startInterpretation)
                                    throws ModuleNotFoundException

Creates new model instance for given model id and properties and possibly starts the model instance interpretation, This can be done either synchronously or asynchronously. If asynchronously, the returned ModelInstanceInfo will not contain the model instance id (the id will be -1).

Parameters:

modelId -

properties -

synchronously -

startInterpretation -

Returns:

execution trace

Throws:

ModuleNotFoundException - if no model exists for the given model id

createAndStartModelInstanceWithParent

ExecutionTrace createAndStartModelInstanceWithParent(long modelId,
                                                     StringProperties properties,
                                                     Long parentModelInstanceId,
                                                     boolean synchronously,
                                                     boolean startInterpretation)
                                              throws ModuleNotFoundException

Creates new model instance for given model id and properties and possibly starts the model instance interpretation, This can be done either synchronously or asynchronously. If asynchronously, the returned execution trace will be empty.

Parameters:

modelId -

properties -

parentModelInstanceId - id of the parent model instance, may be null

synchronously -

startInterpretation -

Returns:

execution trace

Throws:

ModuleNotFoundException - if no model exists for the given model id

terminateModelInstance

ExecutionTrace terminateModelInstance(long modelInstanceId,
                                      boolean synchronously)
                               throws ModelInstanceNotFoundException,
                                      InvalidModelInstanceStateException

Terminates model instance for given model instance id. The top goals are de-activated and the model instance is archived.

Parameters:

modelInstanceId -

synchronously -

Returns:

null or instance of ExecutionTrace, which describes model instance interpretation

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

InvalidModelInstanceStateException - if the model instance is finished

startInterpretModelInstance

ExecutionTrace startInterpretModelInstance(long modelInstanceId,
                                           boolean synchronously)
                                    throws ModelInstanceNotFoundException,
                                           InvalidModelInstanceStateException,
                                           ErrorException

Starts the interpretation of an existing model instance for given model instance id.

Parameters:

modelInstanceId -

synchronously -

Returns:

null or instance of ExecutionTrace, which describes model instance interpretation

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

InvalidModelInstanceStateException - if the model instance is finished

ErrorException

startInterpretModelInstanceSimple

List<Long> startInterpretModelInstanceSimple(long modelInstanceId,
                                             boolean synchronously)
                                      throws ModelInstanceNotFoundException,
                                             InvalidModelInstanceStateException,
                                             ErrorException

Starts the interpretation of an existing model instance for given model instance id.

Parameters:

modelInstanceId -

synchronously -

Returns:

null or List of todo IDs

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

InvalidModelInstanceStateException - if the model instance is finished

ErrorException

sendSignalToModelInstance

ExecutionTrace sendSignalToModelInstance(long modelInstanceId,
                                         ObjectValue signal,
                                         boolean synchronously)
                                  throws ModelInstanceNotFoundException,
                                         InvalidModelInstanceStateException,
                                         ErrorException

Sends a signal to a running model instance.

Parameters:

modelInstanceId -

signal -

synchronously -

Returns:

null or instance of ExecutionTrace, which describes model instance interpretation

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

ErrorException

InvalidModelInstanceStateException

See Also:

SimpleType

removeSignalFromModelInstance

void removeSignalFromModelInstance(long modelInstanceId,
                                   long signalId,
                                   boolean synchronously)
                            throws ModelInstanceNotFoundException,
                                   InvalidModelInstanceStateException,
                                   ErrorException

Removes a signal from a running model instance. Signal which you want to delete is identified by its index in signal queue and model instance by its model instance id.

Parameters:

modelInstanceId -

signalId -

synchronously -

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

ErrorException

InvalidModelInstanceStateException

updateContextVariable

void updateContextVariable(long modelInstanceId,
                           long contextId,
                           String variable,
                           ObjectValue value,
                           boolean synchronously)
                    throws ModelInstanceNotFoundException,
                           InvalidModelInstanceStateException,
                           ErrorException

Updates the value of a given variable.

Parameters:

modelInstanceId -

contextId -

variable -

value -

synchronously -

Throws:

NullPointerException - if variable is null

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

ErrorException

InvalidModelInstanceStateException

updateRecordField

void updateRecordField(long modelInstanceId,
                       String recordType,
                       String recordId,
                       String field,
                       ObjectValue value,
                       boolean synchronously)
                throws ModelInstanceNotFoundException,
                       InvalidModelInstanceStateException,
                       ErrorException

Updates the value of a given record field.

Parameters:

modelInstanceId -

recordType -

recordId - The identifier of the record. The identifier is a string representation of the holder's handle.

field -

value -

synchronously -

Throws:

NullPointerException - if field is null

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

ErrorException

InvalidModelInstanceStateException

updateGoalState

void updateGoalState(long modelInstanceId,
                     long processInstanceId,
                     String goalName,
                     boolean reactivate,
                     boolean synchronously)
              throws ModelInstanceNotFoundException,
                     InvalidModelInstanceStateException,
                     ErrorException

Changes the state of the given goal.

Parameters:

modelInstanceId -

processInstanceId -

goalName -

reactivate - true if the goal should be reactivated

synchronously -

Throws:

NullPointerException - if goalName is null

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

ErrorException

InvalidModelInstanceStateException

getModelInstanceXml

String getModelInstanceXml(long modelInstanceId,
                           List<ModelInstanceData> data)

Returns the specified model instance as an xml structure or null if it does not exist.

Parameters:

modelInstanceId -

data -

Returns:

model instance data values

getCompressedModelInstanceXml

CompressedString getCompressedModelInstanceXml(long modelInstanceId,
                                               List<ModelInstanceData> data)

Returns the specified model instance as an xml structure or null if it does not exist.

Parameters:

modelInstanceId -

data -

Returns:

model instance data values

getRawModelInstanceXml

ByteData getRawModelInstanceXml(long modelInstanceId)

Returns the specified model instance as an xml structure or null if it does not exist.

Unlike getCompressedModelInstanceXml(long, List), this method returns the raw XML as is stored in model instance state. This is useful when the XML is not valid and cannot be unmarshalled by JAXB.

Parameters:

modelInstanceId -

Returns:

model instance data values

getCompressedRawModelInstanceXml

CompressedData getCompressedRawModelInstanceXml(long modelInstanceId)

Returns the specified model instance as an xml structure or null if it does not exist.

Unlike getCompressedModelInstanceXml(long, List), this method returns the raw XML as is stored in model instance state. This is useful when the XML is not valid and cannot be unmarshalled by JAXB.

Parameters:

modelInstanceId -

Returns:

model instance data values

setRawModelInstanceXml

void setRawModelInstanceXml(long modelInstanceId,
                            ByteData data)
                     throws ModelInstanceNotFoundException,
                            InvalidModelInstanceStateException

Sets the model instance state.

Parameters:

modelInstanceId -

data -

Throws:

InvalidModelInstanceStateException

ModelInstanceNotFoundException

setCompressedRawModelInstanceXml

void setCompressedRawModelInstanceXml(long modelInstanceId,
                                      CompressedData data)
                               throws ModelInstanceNotFoundException,
                                      InvalidModelInstanceStateException

Sets the model instance state.

Parameters:

modelInstanceId -

data -

Throws:

InvalidModelInstanceStateException

ModelInstanceNotFoundException

suspendModelInstance

void suspendModelInstance(long modelInstanceId,
                          boolean synchronously)
                   throws ModelInstanceNotFoundException,
                          InvalidModelInstanceStateException,
                          ErrorException

Suspends model instance execution.

Parameters:

modelInstanceId -

synchronously -

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

InvalidModelInstanceStateException

ErrorException

resumeModelInstance

void resumeModelInstance(long modelInstanceId,
                         boolean synchronously)
                  throws ModelInstanceNotFoundException,
                         InvalidModelInstanceStateException,
                         ErrorException

Resumes model instance execution.

Parameters:

modelInstanceId -

synchronously -

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

ErrorException

InvalidModelInstanceStateException

notifyModelInstance

void notifyModelInstance(long modelInstanceId,
                         String reason,
                         boolean synchronously)
                  throws ModelInstanceNotFoundException,
                         InvalidModelInstanceStateException,
                         ErrorException

Notifies a model instance.

Parameters:

modelInstanceId -

reason -

synchronously -

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

ErrorException

InvalidModelInstanceStateException

notifyTask

void notifyTask(long modelInstanceId,
                long taskId,
                String reason,
                boolean synchronously)
         throws ModelInstanceNotFoundException,
                InvalidModelInstanceStateException,
                ErrorException

Notifies a task in model instance.

Parameters:

modelInstanceId -

taskId -

reason -

synchronously -

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

ErrorException

InvalidModelInstanceStateException

removeAllFormPreviewModelInstances

void removeAllFormPreviewModelInstances()

Removes all model instances created by form preview.

resolveReference

ExternalRecordValue resolveReference(long modelInstanceId,
                                     ExternalRecordValue value)
                              throws ModelInstanceNotFoundException

Resolves external record value reference to a value, attributes of which are populated.

Parameters:

modelInstanceId - the identifier of the model instance in which the value is defined

value - an external record value which is just a reference, that is it's ExternalRecordValue.isReferenceOnly() returns true.

Returns:

an external record value with populated attributes

Throws:

ModelInstanceNotFoundException

See Also:

ExternalRecordValue.isReferenceOnly()

restartModelInstances

void restartModelInstances(Collection<Long> modelInstanceIds,
                           long newModuleId)
                    throws ModelInstanceNotFoundException,
                           InvalidModelInstanceStateException,
                           ErrorException

Restarts model instances with new model. State of each model instance is backed up.

Parameters:

modelInstanceIds -

newModuleId - id of the new module, if -1 the current model of each instance is used

Throws:

ModelInstanceNotFoundException

InvalidModelInstanceStateException

ErrorException