|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface InstanceManagementAPI
Manage a process instance.
Method Summary | |
---|---|
void |
exit(ProcessInstanceUUID processInstanceUUID)
Exit the given instance. |
List<JobData> |
findJobsWithException()
Get the list of asynchronous executions for which all the tries have failed and which will not be executed any more. |
List<PendingMessageData> |
getPendingMessages()
Get the list of messages received by the engine but not yet associated with any execution. |
boolean |
remove(ProcessInstanceUUID processInstanceUUID)
To delete monitoring information on the process instance. |
void |
removePendingMessage(PendingMessageData message)
Remove the message from the list of messages received by the engine but not yet associated with any execution. |
void |
resume(ProcessInstanceUUID processInstanceUUID)
Resume a previously suspend instance of a process. |
void |
retryJob(JobData job,
int retries)
Reschedules a job (asynchronous execution). |
void |
suspend(ProcessInstanceUUID processInstanceUUID)
Suspend the given instance of a process. |
Method Detail |
---|
void exit(ProcessInstanceUUID processInstanceUUID) throws InstanceNotFoundException
processInstanceUUID
- the Id of the instance to exit.
InstanceNotFoundException
- thrown if the given instance to exit is not found.void resume(ProcessInstanceUUID processInstanceUUID) throws InstanceNotFoundException
processInstanceUUID
- the process instance UUID that identify the instance to resume.
InstanceNotFoundException
- thrown if the given instance to resume is not found.void suspend(ProcessInstanceUUID processInstanceUUID) throws InstanceNotFoundException
processInstanceUUID
- the process instance UUID that identify the instance to suspend.
InstanceNotFoundException
- thrown if the given instance to suspend is not found.boolean remove(ProcessInstanceUUID processInstanceUUID)
processInstanceUUID
- the process instance UUID that identify the instance to suspend.
List<JobData> findJobsWithException()
void retryJob(JobData job, int retries) throws JobNotFoundException
job
- the job to retry.retries
- the number of retries to set for the job.
JobNotFoundException
- if job does not exist.List<PendingMessageData> getPendingMessages()
void removePendingMessage(PendingMessageData message)
message
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |