Skip navigation links

oracle.bpm.services.instancemanagement
Interface IInstanceManagementService

public interface IInstanceManagementService

Since:

release specific (what release of product did this appear in)

Method Summary

IProcessAttachment	addAttachment(IBPMContext context, IProcessInstance instance, IProcessAttachment attachment) To add attachment to the process
IProcessComment	addComment(IBPMContext context, IProcessInstance instance, IProcessComment comment) To add the comment to process instance
void	cancelProcessInstance(IBPMContext context, IProcessInstance instance) Cancels a process instance in execution.
java.lang.String	createProcessInstance(IBPMContext context, java.lang.String processId) Creates a process instance for the specified target process.
Task	createProcessInstanceTask(IBPMContext context, java.lang.String processId)
void	deleteProcessAttachments(IBPMContext context, IProcessInstance instance, IProcessAttachment attachment) To delete the
java.util.List<java.lang.String>	getAllowedActions(IBPMContext context, IProcessInstance instance) Retrieves allowed actions on the specified instance for authenticated user in context.
IGrabInstanceResponse	grabInstance(IBPMContext context, IGrabInstanceRequest grabInstanceRequest) To invokes callback for activity instance is waiting on and resumes instance // * @param subscriberId
IGrabMultipleInstancesResponse	grabMultipleInstances(IBPMContext context, java.io.File alterFlowModel, java.lang.Iterable<IProcessInstance> instances)
IGrabMultipleInstancesResponse	grabMultipleInstances(IBPMContext context, IGrabMultipleInstancesRequest grabMultipleInstancesRequest)
IMigrateInstanceResponse	migrateInstance(IBPMContext context, IMigrateInstanceRequest migrateInstanceRequest)
IMigrateMultipleInstancesResponse	migrateMultipleInstances(IBPMContext context, java.io.File alterFlowModel, java.lang.Iterable<IProcessInstance> instances)
IMigrateMultipleInstancesResponse	migrateMultipleInstances(IBPMContext context, IMigrateMultipleInstancesRequest migrateMultipleInstancesRequest)
boolean	resumeComponent(IBPMContext context, java.lang.String processDN)
boolean	resumeInstance(IBPMContext context, IProcessInstance instance)
boolean	suspendComponent(IBPMContext context, java.lang.String processDN)
boolean	suspendInstance(IBPMContext context, IProcessInstance instance)
void	updateProcessInstance(IBPMContext context, IProcessInstance instance) Deprecated. This method will be removed in 12

Method Detail

createProcessInstance

java.lang.String createProcessInstance(IBPMContext context,
                                       java.lang.String processId)
                                       throws BPMException

Creates a process instance for the specified target process.

Parameters:

context - IBPMContext context of user.

processId - target process id.

Returns:

instance id of the created process instance.

Throws:

BPMException

createProcessInstanceTask

Task createProcessInstanceTask(IBPMContext context,
                               java.lang.String processId)
                               throws BPMException

Throws:

BPMException

addComment

IProcessComment addComment(IBPMContext context,
                           IProcessInstance instance,
                           IProcessComment comment)
                           throws BPMException

To add the comment to process instance

Parameters:

context - IBPMContext context of user

instance - IProcessInstance instace of process

comment - IProcessComment process comment

Returns:

IProcessComment

Throws:

BPMException

addAttachment

IProcessAttachment addAttachment(IBPMContext context,
                                 IProcessInstance instance,
                                 IProcessAttachment attachment)
                                 throws BPMException

To add attachment to the process

Parameters:

context -

instance -

attachment -

Returns:

Throws:

BPMException

cancelProcessInstance

void cancelProcessInstance(IBPMContext context,
                           IProcessInstance instance)
                           throws BPMException

Cancels a process instance in execution.

Parameters:

context - User context

instance - Instance to be canceled

Throws:

BPMException

getAllowedActions

java.util.List<java.lang.String> getAllowedActions(IBPMContext context,
                                                   IProcessInstance instance)
                                                   throws BPMException

Retrieves allowed actions on the specified instance for authenticated user in context.

Parameters:

context - User context

instance - Instance to be queried for permissions

Returns:

List of allowed actions on the specified instance for authenticated user in context.

Throws:

BPMException

deleteProcessAttachments

void deleteProcessAttachments(IBPMContext context,
                              IProcessInstance instance,
                              IProcessAttachment attachment)
                              throws BPMException

To delete the

Parameters:

context -

instance -

attachment -

Throws:

BPMException

updateProcessInstance

@Deprecated
void updateProcessInstance(IBPMContext context,
                                      IProcessInstance instance)
                           throws BPMException

Deprecated. This method will be removed in 12

Update the process instance modifiable fields : title, priority

Parameters:

context -

instance -

Throws:

BPMException

grabInstance

IGrabInstanceResponse grabInstance(IBPMContext context,
                                   IGrabInstanceRequest grabInstanceRequest)
                                   throws BPMException

To invokes callback for activity instance is waiting on and resumes instance // * @param subscriberId

Throws:

BPMException

grabMultipleInstances

IGrabMultipleInstancesResponse grabMultipleInstances(IBPMContext context,
                                                     IGrabMultipleInstancesRequest grabMultipleInstancesRequest)
                                                     throws BPMException

Throws:

BPMException

migrateInstance

IMigrateInstanceResponse migrateInstance(IBPMContext context,
                                         IMigrateInstanceRequest migrateInstanceRequest)
                                         throws BPMException

Throws:

BPMException

migrateMultipleInstances

IMigrateMultipleInstancesResponse migrateMultipleInstances(IBPMContext context,
                                                           IMigrateMultipleInstancesRequest migrateMultipleInstancesRequest)
                                                           throws BPMException

Throws:

BPMException

suspendInstance

boolean suspendInstance(IBPMContext context,
                        IProcessInstance instance)
                        throws BPMException

Throws:

BPMException

resumeInstance

boolean resumeInstance(IBPMContext context,
                       IProcessInstance instance)
                       throws BPMException

Throws:

BPMException

suspendComponent

boolean suspendComponent(IBPMContext context,
                         java.lang.String processDN)
                         throws BPMException

Throws:

BPMException

resumeComponent

boolean resumeComponent(IBPMContext context,
                        java.lang.String processDN)
                        throws BPMException

Throws:

BPMException

grabMultipleInstances

IGrabMultipleInstancesResponse grabMultipleInstances(IBPMContext context,
                                                     java.io.File alterFlowModel,
                                                     @Nullable
                                                     java.lang.Iterable<IProcessInstance> instances)
                                                     throws BPMException

Throws:

BPMException

migrateMultipleInstances

IMigrateMultipleInstancesResponse migrateMultipleInstances(IBPMContext context,
                                                           java.io.File alterFlowModel,
                                                           @Nullable
                                                           java.lang.Iterable<IProcessInstance> instances)
                                                           throws BPMException

Throws:

BPMException

Skip navigation links