Oracle Fusion Middleware
Java API Reference for Oracle BPM Suite
11g Release 1 (11.1.1.7.0)
E25378-07

oracle.bpm.services.instancemanagement
Interface IInstanceManagementService


public interface IInstanceManagementService

Since:
release specific (what release of product did this appear in) This interface provides execution and management operations over Process Instances.

All methods in this interface throw a BPMException if an error occur executing the operation.


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
 void deleteProcessInstance(IBPMContext context, java.lang.String processInstanceId)
          Delete a process instance
 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)
          grabInstance lets you modify the instance by modifying data objects, correlation keys and process instance attributes.
 IGrabMultipleInstancesResponse grabMultipleInstances(IBPMContext context, java.io.File alterFlowModel, java.lang.Iterable<IProcessInstance> instances)
          grabMultipleInstances allows you to grab to multiple process instances
 IGrabMultipleInstancesResponse grabMultipleInstances(IBPMContext context, IGrabMultipleInstancesRequest grabMultipleInstancesRequest)
          grabMultipleInstances allows you to grab to multiple process instances.
 IMigrateInstanceResponse migrateInstance(IBPMContext context, IMigrateInstanceRequest migrateInstanceRequest)
          migrateInstance lets you migrate a process instance from the same revision after a redeploy with keep instances running.
 IMigrateMultipleInstancesResponse migrateMultipleInstances(IBPMContext context, java.io.File alterFlowModel, java.lang.Iterable<IProcessInstance> instances)
          migrateMultipleInstances allows you to migrate multiple process instances
 IMigrateMultipleInstancesResponse migrateMultipleInstances(IBPMContext context, IMigrateMultipleInstancesRequest migrateMultipleInstancesRequest)
          migrateMultipleInstances allows you to migrate multiple process instances.
 boolean resumeComponent(IBPMContext context, java.lang.String processDN)
          resumeComponent allows you to resume a component
 boolean resumeInstance(IBPMContext context, IProcessInstance instance)
          resumeInstance allows you to resume a process instance.
 boolean suspendComponent(IBPMContext context, java.lang.String processDN)
          suspendComponent allows you to suspend a component.
 boolean suspendInstance(IBPMContext context, IProcessInstance instance)
          suspendInstance allows you to suspend a process instance.
 void updateProcessInstance(IBPMContext context, IProcessInstance instance)
          Deprecated. This method will be removed in 12
 void updateTask(IBPMContext context, ITaskUpdateAction action)
           
 

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
grabInstance lets you modify the instance by modifying data objects, correlation keys and process instance attributes. It can also provide flow updates to move from one activity to another according to certain restrictions.

Parameters:
context - the bpm identity context.
grabInstanceRequest - the request containing the alter flow modifications to apply.
Returns:
the response of the result of the grab operation.
Throws:
BPMException

grabMultipleInstances

IGrabMultipleInstancesResponse grabMultipleInstances(IBPMContext context,
                                                     IGrabMultipleInstancesRequest grabMultipleInstancesRequest)
                                                     throws BPMException
grabMultipleInstances allows you to grab to multiple process instances.

Parameters:
context - the bpm identity context.
grabMultipleInstancesRequest - the request containing the alter flow modifications to apply.
Returns:
the response of the result of the grab operation.
Throws:
BPMException

migrateInstance

IMigrateInstanceResponse migrateInstance(IBPMContext context,
                                         IMigrateInstanceRequest migrateInstanceRequest)
                                         throws BPMException
migrateInstance lets you migrate a process instance from the same revision after a redeploy with keep instances running. You can modify data objects, correlation keys, process instance attributes and you can also can do flow updates

Parameters:
context - the bpm identity context.
migrateInstanceRequest - the request containing the modifications to apply.
Returns:
the response of the result of the migrate operation.
Throws:
BPMException

migrateMultipleInstances

IMigrateMultipleInstancesResponse migrateMultipleInstances(IBPMContext context,
                                                           IMigrateMultipleInstancesRequest migrateMultipleInstancesRequest)
                                                           throws BPMException
migrateMultipleInstances allows you to migrate multiple process instances.

Parameters:
context - the bpm identity context.
migrateMultipleInstancesRequest - the migration request of the process instances.
Returns:
the response of the result of the migrate operation.
Throws:
BPMException

suspendInstance

boolean suspendInstance(IBPMContext context,
                        IProcessInstance instance)
                        throws BPMException
suspendInstance allows you to suspend a process instance.

Parameters:
context - bpm identity context.
instance - the instance to suspend.
Returns:
true if the instance was suspended, false otherwise.
Throws:
BPMException

resumeInstance

boolean resumeInstance(IBPMContext context,
                       IProcessInstance instance)
                       throws BPMException
resumeInstance allows you to resume a process instance.

Parameters:
context - bpm identity context.
instance - the instance to resume.
Returns:
true if the instance was resumed, false otherwise.
Throws:
BPMException

suspendComponent

boolean suspendComponent(IBPMContext context,
                         java.lang.String processDN)
                         throws BPMException
suspendComponent allows you to suspend a component.

Parameters:
context - bpm identity context.
processDN - the Process DN of the component to suspend.
Returns:
true if the component was suspended, false otherwise.
Throws:
BPMException

resumeComponent

boolean resumeComponent(IBPMContext context,
                        java.lang.String processDN)
                        throws BPMException
resumeComponent allows you to resume a component

Parameters:
context - bpm identity context.
processDN - the Process DN of the component to resume.
Returns:
true if the component was suspended, false otherwise.
Throws:
BPMException

grabMultipleInstances

IGrabMultipleInstancesResponse grabMultipleInstances(IBPMContext context,
                                                     java.io.File alterFlowModel,
                                                     @Nullable
                                                     java.lang.Iterable<IProcessInstance> instances)
                                                     throws BPMException
grabMultipleInstances allows you to grab to multiple process instances

Parameters:
context - the bpm identity context
instances - the process instances to grab
Returns:
the response of the result of the grab operation
Throws:
BPMException

migrateMultipleInstances

IMigrateMultipleInstancesResponse migrateMultipleInstances(IBPMContext context,
                                                           java.io.File alterFlowModel,
                                                           @Nullable
                                                           java.lang.Iterable<IProcessInstance> instances)
                                                           throws BPMException
migrateMultipleInstances allows you to migrate multiple process instances

Parameters:
context - the bpm identity context
instances - the process instances to migrate
Returns:
the response of the result of the migrate operation
Throws:
BPMException

updateTask

void updateTask(IBPMContext context,
                ITaskUpdateAction action)
                throws BPMException
Throws:
BPMException

deleteProcessInstance

void deleteProcessInstance(IBPMContext context,
                           java.lang.String processInstanceId)
                           throws BPMException
Delete a process instance

Parameters:
context - bpm identity context
processInstanceId - the id of the process instance to delete
Throws:
BPMException

Oracle Fusion Middleware
Java API Reference for Oracle BPM Suite
11g Release 1 (11.1.1.7.0)
E25378-07

Copyright © 2009, 2013, Oracle and/or its affiliates. All rights reserved.