Package su.onno.process

Interface ProcessEngine

All Known Implementing Classes:

JdbcProcessEngine

public interface ProcessEngine

Transactional durable runtime for typed process definitions.

Method Summary

Modifier and Type	Method	Description
ProcessSnapshot	cancel(UUID instanceId, String reason, ProcessActor actor)	Cancel an active process and all of its live tasks, timers, branches, and subprocesses.
ProcessWorkItem	claim(UUID workItemId, ProcessActor actor)
ProcessSnapshot	complete(UUID workItemId, String outcome, ProcessActor actor)	Dynamic/transport boundary used when an enum constant arrives as JSON text.
default <O extends Enum<O>> ProcessSnapshot	complete(UUID workItemId, O outcome, ProcessActor actor)	Complete from typed Java; the enum constant is validated again against the active task.
ProcessWorkItem	delegate(UUID workItemId, ProcessIdentity target, String reason, ProcessActor actor)	Transfer a claimed task to another stable authenticated identity.
Optional<ProcessSnapshot>	find(UUID instanceId)
List<ProcessTransitionSnapshot>	history(UUID instanceId)
List<ProcessWorkItem>	inbox(ProcessActor actor)
List<ProcessSnapshot>	instances(ProcessActor actor)	Process instances visible to an actor through start, participation, or administration.
ProcessSnapshot	migrate(UUID instanceId, ProcessActor actor)	Apply the registered definition-migration chain to the latest definition version.
int	runPending(int limit)	Advance due timers and completed/cancelled subprocess waits.
<P, S extends Enum<S> & ProcessStepKey> ProcessSnapshot	start(ProcessDefinition<P,S> definition, P payload, ProcessActor actor)
List<ProcessTokenSnapshot>	tokens(UUID instanceId)	Active and historical execution tokens for an inspectable process timeline.
List<ProcessWorkItemEventSnapshot>	workItemHistory(UUID workItemId, ProcessActor actor)	Authorized, chronological audit history for one human task.

Method Details

start

<P,
S extends Enum<S> & ProcessStepKey>
ProcessSnapshot start(ProcessDefinition<P,S> definition,
 P payload,
 ProcessActor actor)

find

Optional<ProcessSnapshot> find(UUID instanceId)

instances

List<ProcessSnapshot> instances(ProcessActor actor)

Process instances visible to an actor through start, participation, or administration.

history

List<ProcessTransitionSnapshot> history(UUID instanceId)

tokens

List<ProcessTokenSnapshot> tokens(UUID instanceId)

Active and historical execution tokens for an inspectable process timeline.

inbox

List<ProcessWorkItem> inbox(ProcessActor actor)

claim

ProcessWorkItem claim(UUID workItemId,
 ProcessActor actor)

delegate

ProcessWorkItem delegate(UUID workItemId,
 ProcessIdentity target,
 String reason,
 ProcessActor actor)

Transfer a claimed task to another stable authenticated identity.

The current assignee (or an administrator) may delegate. The reason is required and the transfer is recorded in workItemHistory(java.util.UUID, su.onno.process.ProcessActor).

workItemHistory

List<ProcessWorkItemEventSnapshot> workItemHistory(UUID workItemId,
 ProcessActor actor)

Authorized, chronological audit history for one human task.

complete

default <O extends Enum<O>> ProcessSnapshot complete(UUID workItemId,
 O outcome,
 ProcessActor actor)

Complete from typed Java; the enum constant is validated again against the active task.

complete

ProcessSnapshot complete(UUID workItemId,
 String outcome,
 ProcessActor actor)

Dynamic/transport boundary used when an enum constant arrives as JSON text.

cancel

ProcessSnapshot cancel(UUID instanceId,
 String reason,
 ProcessActor actor)

Cancel an active process and all of its live tasks, timers, branches, and subprocesses.

migrate

ProcessSnapshot migrate(UUID instanceId,
 ProcessActor actor)

Apply the registered definition-migration chain to the latest definition version.

runPending

int runPending(int limit)

Advance due timers and completed/cancelled subprocess waits.

The starter invokes this from its durable background-job scheduler. Calling it from application code is safe; row locks and token state make duplicate polls no-ops.