A B C D E F G H I J L M N O P R S T U V W

A

Activity - Interface in org.jbpm.api.model

a activity in a OpenProcessDefinition graph.

ActivityBehaviour - Interface in org.jbpm.api.activity

implements the runtime behaviour of an activity.

ActivityCoordinates - Interface in org.jbpm.api.model

activity coordinates indicating the graphical position in the diagram.

ActivityExecution - Interface in org.jbpm.api.activity

view upon an Execution exposed to ActivityBehaviour implementations.

activityInstanceId(String) - Method in interface org.jbpm.api.history.HistoryDetailQuery

only select details for the given activityInstanceId

activityName(String) - Method in interface org.jbpm.api.history.HistoryActivityInstanceQuery

only select activity instances for the given activity (this usually used in combination with HistoryActivityInstanceQuery.processDefinitionId(String))

activityName(String) - Method in interface org.jbpm.api.TaskQuery

only select tasks that are associated to the given activity name.

addCandidateGroup(String) - Method in interface org.jbpm.api.task.Assignable

add the members of the given group as candidates to the task or swimlane

addCandidateUser(String) - Method in interface org.jbpm.api.task.Assignable

add the given user as a candidate to the task or swimlane

addReplyComment(String, String) - Method in interface org.jbpm.api.TaskService

add a reply to another comment

addResourceFromClasspath(String) - Method in interface org.jbpm.api.NewDeployment

adds a resource as a resource from the classpath

addResourceFromFile(File) - Method in interface org.jbpm.api.NewDeployment

adds a resource from a file

addResourceFromInputStream(String, InputStream) - Method in interface org.jbpm.api.NewDeployment

adds a resource as a string

addResourceFromString(String, String) - Method in interface org.jbpm.api.NewDeployment

adds a resource as a string

addResourceFromUrl(URL) - Method in interface org.jbpm.api.NewDeployment

adds a resource as a url

addResourcesFromZipInputStream(ZipInputStream) - Method in interface org.jbpm.api.NewDeployment

adds a resource as a zip stream

addTaskComment(String, String) - Method in interface org.jbpm.api.TaskService

add a comment to a task

addTaskParticipatingGroup(String, String, String) - Method in interface org.jbpm.api.TaskService

add a role to a given task.

addTaskParticipatingUser(String, String, String) - Method in interface org.jbpm.api.TaskService

add a role to a given task.

ASSIGN - Static variable in interface org.jbpm.api.model.Event

fired when a task is assigned

assign(Assignable, OpenExecution) - Method in interface org.jbpm.api.task.AssignmentHandler

sets the actorId and candidates for the given task.

Assignable - Interface in org.jbpm.api.task

tasks or swimlanes can be assigned.

assignee(String) - Method in interface org.jbpm.api.history.HistoryTaskQuery

only select history tasks for the given assignee

assignee(String) - Method in interface org.jbpm.api.TaskQuery

only select tasks for which the given user is the assignee

AssignmentHandler - Interface in org.jbpm.api.task

interface to delegate Task or Swimlane assignment.

assignTask(String, String) - Method in interface org.jbpm.api.TaskService

assigns this task to the given assignee.

avgDurationPerActivity(String) - Method in interface org.jbpm.api.HistoryService

returns the average duration in milliseconds for each activity in the given process definition

B

buildProcessEngine() - Method in class org.jbpm.api.Configuration

after specifying the configuration resources with the other methods, a process engine can be created.

C

CANDIDATE - Static variable in interface org.jbpm.api.task.Participation

alternative owner, but as long as this person is not the owner.

candidate(String) - Method in interface org.jbpm.api.TaskQuery

only query for tasks for which the given user is a candidate.

choiceDistribution(String, String) - Method in interface org.jbpm.api.HistoryService

returns for each transitionName, the number of times that transition was taken

CLIENT - Static variable in interface org.jbpm.api.task.Participation

person that will be using the result of this task.

close() - Method in interface org.jbpm.api.ProcessEngine

clean shutdown of the engine.

Command<T> - Interface in org.jbpm.api.cmd

commands that can be executed by the process engine.

comments() - Method in interface org.jbpm.api.history.HistoryDetailQuery

only select details of type comment (this usually used in combination with #processDefinitionId(String))

completeTask(String) - Method in interface org.jbpm.api.TaskService

Deletes this task, marks the related history task as completed.

completeTask(String, Map<String, ?>) - Method in interface org.jbpm.api.TaskService

Deletes this task and marks the related history task as completed.

completeTask(String, String) - Method in interface org.jbpm.api.TaskService

Deletes this task, marks the related history task as completed with the specified outcome.

completeTask(String, String, Map<String, ?>) - Method in interface org.jbpm.api.TaskService

Deletes this task, marks the related history task as completed with the specified outcome.

Configuration - Class in org.jbpm.api

process engine configuration.

Configuration() - Constructor for class org.jbpm.api.Configuration

default constructor

Configuration(Object) - Constructor for class org.jbpm.api.Configuration

count() - Method in interface org.jbpm.api.DeploymentQuery

execute a count(*) query and returns number of results

count() - Method in interface org.jbpm.api.history.HistoryActivityInstanceQuery

execute a count(*) query and returns number of results

count() - Method in interface org.jbpm.api.history.HistoryDetailQuery

execute a count(*) query and returns number of results

count() - Method in interface org.jbpm.api.history.HistoryProcessInstanceQuery

execute a count(*) query and returns number of results

count() - Method in interface org.jbpm.api.history.HistoryTaskQuery

execute a count(*) query and returns number of results

count() - Method in interface org.jbpm.api.JobQuery

execute a count(*) query and returns number of results

count() - Method in interface org.jbpm.api.ProcessDefinitionQuery

execute a count(*) query and returns number of results

count() - Method in interface org.jbpm.api.ProcessInstanceQuery

execute a count(*) query and returns number of results

count() - Method in interface org.jbpm.api.TaskQuery

execute a count(*) query and returns number of results

createDeployment() - Method in interface org.jbpm.api.RepositoryService

create a new deployment.

createDeploymentQuery() - Method in interface org.jbpm.api.RepositoryService

create a query for deployments

createGroup(String) - Method in interface org.jbpm.api.IdentityService

create a group new group

createGroup(String, String) - Method in interface org.jbpm.api.IdentityService

create a group new group

createGroup(String, String, String) - Method in interface org.jbpm.api.IdentityService

create a group new group

createHistoryActivityInstanceQuery() - Method in interface org.jbpm.api.HistoryService

search in history activity instance information

createHistoryDetailQuery() - Method in interface org.jbpm.api.HistoryService

search in history details

createHistoryProcessInstanceQuery() - Method in interface org.jbpm.api.HistoryService

search for process instances in the history

createHistoryTaskQuery() - Method in interface org.jbpm.api.HistoryService

search in history task information

createJobQuery() - Method in interface org.jbpm.api.ManagementService

search for jobs

createMembership(String, String) - Method in interface org.jbpm.api.IdentityService

makes the given user a member of the given group.

createMembership(String, String, String) - Method in interface org.jbpm.api.IdentityService

makes the given user a member of the given group with the given role.

createProcessDefinitionQuery() - Method in interface org.jbpm.api.RepositoryService

create a query for process definitions

createProcessInstanceQuery() - Method in interface org.jbpm.api.ExecutionService

search for process instances with criteria.

createTaskQuery() - Method in interface org.jbpm.api.TaskService

create a new query for tasks

createUser(String, String, String) - Method in interface org.jbpm.api.IdentityService

create a new user.

createUser(String, String, String, String) - Method in interface org.jbpm.api.IdentityService

create a new user, providing an email address

createVariable(String, String, Object, boolean) - Method in interface org.jbpm.api.ExecutionService

creates a variable value in the referenced execution. optionally enables variable history tracking.

createVariable(String, Object) - Method in interface org.jbpm.api.model.OpenExecution

create a new variable in this execution scope and determine the type automagically.

createVariables(String, Map<String, ?>, boolean) - Method in interface org.jbpm.api.ExecutionService

creates variable values in the referenced execution. optionally enables variable history tracking.

D

decide(OpenExecution) - Method in interface org.jbpm.api.jpdl.DecisionHandler

the name of the selected outgoing transition

DecisionHandler - Interface in org.jbpm.api.jpdl

interface for supplying user programmed decisions.

deleteComment(String) - Method in interface org.jbpm.api.TaskService

delete a comment.

deleteDeployment(String) - Method in interface org.jbpm.api.RepositoryService

deletes a deployment if the process definitions don't have running executions.

deleteDeploymentCascade(String) - Method in interface org.jbpm.api.RepositoryService

deletes deployment, contained process definitions, related process instances and their history information

deleteGroup(String) - Method in interface org.jbpm.api.IdentityService

deletes the given group.

deleteJob(long) - Method in interface org.jbpm.api.ManagementService

Deletes the job with the given id.

deleteMembership(String, String, String) - Method in interface org.jbpm.api.IdentityService

deletes the identified relation between a user and a group.

deleteProcessInstance(String) - Method in interface org.jbpm.api.ExecutionService

delete a process instance.

deleteProcessInstanceCascade(String) - Method in interface org.jbpm.api.ExecutionService

delete a process instance, including the history information.

deleteTask(String) - Method in interface org.jbpm.api.TaskService

Deletes the task without completing it.

deleteTask(String, String) - Method in interface org.jbpm.api.TaskService

Deletes the task without completing indicating the reason.

deleteTaskCascade(String) - Method in interface org.jbpm.api.TaskService

deletes this task, including all history information

deleteUser(String) - Method in interface org.jbpm.api.IdentityService

delete the given user.

deploy() - Method in interface org.jbpm.api.NewDeployment

after adding resources, this will perform the actual deployment.

Deployment - Interface in org.jbpm.api

represents an existing deployment in the repository.

deploymentId(String) - Method in interface org.jbpm.api.DeploymentQuery

only include a specific deployment by id

deploymentId(String) - Method in interface org.jbpm.api.ProcessDefinitionQuery

select only process definitions within the given deployment

DeploymentQuery - Interface in org.jbpm.api

find existing deployments in the repository.

E

end() - Method in interface org.jbpm.api.activity.ActivityExecution

ends this execution and all of its child executions.

end(String) - Method in interface org.jbpm.api.activity.ActivityExecution

ends this execution and all it's child executions with a user defined status.

END - Static variable in interface org.jbpm.api.model.Event

fired when a process or an activity ends

ended() - Method in interface org.jbpm.api.history.HistoryProcessInstanceQuery

select only process instances that have ended.

endedAfter(Date) - Method in interface org.jbpm.api.history.HistoryProcessInstanceQuery

select only process instances that have ended on or after the given date.

endedBefore(Date) - Method in interface org.jbpm.api.history.HistoryProcessInstanceQuery

select only process instances that have ended before the given date.

endProcessInstance(String, String) - Method in interface org.jbpm.api.ExecutionService

end a process instance

Environment - Interface in org.jbpm.api.cmd

exposes configured process engine scope objects and transaction scope objects to command implementations.

Event - Interface in org.jbpm.api.model

event constants.

EventListener - Interface in org.jbpm.api.listener

listener to process execution events.

EventListenerExecution - Interface in org.jbpm.api.listener

view upon an path of execution exposed to EventListener implementations.

exception(boolean) - Method in interface org.jbpm.api.JobQuery

only select jobs that were rolled back due to an exception

execute(ActivityExecution) - Method in interface org.jbpm.api.activity.ActivityBehaviour

invoked when an execution arrives in an activity.

execute(String) - Method in interface org.jbpm.api.activity.ActivityExecution

executes the given nested activity.

execute(Environment) - Method in interface org.jbpm.api.cmd.Command

execute(Environment) - Method in class org.jbpm.api.cmd.VoidCommand

execute(Command<T>) - Method in interface org.jbpm.api.ProcessEngine

perform a user command.

executeJob(String) - Method in interface org.jbpm.api.ManagementService

resets the retry count, clears the exception and executes the job.

executeVoid(Environment) - Method in class org.jbpm.api.cmd.VoidCommand

Execution - Interface in org.jbpm.api

a runtime path of execution.

executionId(String) - Method in interface org.jbpm.api.history.HistoryActivityInstanceQuery

only select activity instances for the given execution

executionId(String) - Method in interface org.jbpm.api.history.HistoryTaskQuery

only select history tasks within the given execution

executionId(String) - Method in interface org.jbpm.api.TaskQuery

only select tasks that are associated to the given execution

ExecutionService - Interface in org.jbpm.api

manages runtime process executions.

ExternalActivityBehaviour - Interface in org.jbpm.api.activity

extends ActivityBehaviour for handling external triggers after a wait state.

F

findActiveActivityNames() - Method in interface org.jbpm.api.Execution

get the set of all activities that are active.

findActiveExecutionIn(String) - Method in interface org.jbpm.api.Execution

search for an execution that is active and in the given activityName.

findActiveExecutionIn(String) - Method in interface org.jbpm.api.model.OpenExecution

find the execution in the given activity or null if no such activity exists

findActivity(String) - Method in interface org.jbpm.api.model.Activity

searches for the given activity in this element recursively, including this activity and all child activities.

findExecutionById(String) - Method in interface org.jbpm.api.ExecutionService

the path of execution that is uniquely defined by the execution id.

findGroupById(String) - Method in interface org.jbpm.api.IdentityService

lookup a group.

findGroupIdsByUser(String) - Method in interface org.jbpm.api.IdentityService

all group ids (String) for which this user is a member.

findGroupsByUser(String) - Method in interface org.jbpm.api.IdentityService

all group ids (String) for which this user is a member.

findGroupsByUserAndGroupType(String, String) - Method in interface org.jbpm.api.IdentityService

groups of the given groupType for which the given user is a member.

findGroupTasks(String) - Method in interface org.jbpm.api.TaskService

list of tasks that can be taken by the given user.

findOutgoingTransition(String) - Method in interface org.jbpm.api.model.Activity

searches for the given transitionName in this activity and then up the parent chain.

findPersonalTasks(String) - Method in interface org.jbpm.api.TaskService

list of tasks that are assigned to the given user.

findProcessInstanceById(String) - Method in interface org.jbpm.api.ExecutionService

the process instance that is uniquely defined by the process execution id.

findUserById(String) - Method in interface org.jbpm.api.IdentityService

lookup a user

findUsers() - Method in interface org.jbpm.api.IdentityService

get all the users in the system.

G

get(String) - Method in interface org.jbpm.api.cmd.Environment

searches a named object in all the contexts in the default search order.

get(Class<T>) - Method in interface org.jbpm.api.cmd.Environment

searches an object based on type.

get(Class<T>) - Method in interface org.jbpm.api.ProcessEngine

retrieve and object defined in the process engine by type

get(String) - Method in interface org.jbpm.api.ProcessEngine

retrieve and object defined in the process engine by name

getActivities() - Method in interface org.jbpm.api.model.Activity

the list of direct composite activities.

getActivitiesMap() - Method in interface org.jbpm.api.model.Activity

the composite activities, keyed by activity name.

getActivity(String) - Method in interface org.jbpm.api.model.Activity

the first composite activity with the given name or null of no such activity exists.

getActivity() - Method in interface org.jbpm.api.model.OpenExecution

the current activity

getActivityCoordinates(String, String) - Method in interface org.jbpm.api.RepositoryService

the coordinates for the activity on the process image.

getActivityName() - Method in interface org.jbpm.api.activity.ActivityExecution

represents the current position in the process by indicating the name of the current activity.

getActivityName() - Method in interface org.jbpm.api.history.HistoryActivityInstance

name of the activity that was executed

getActivityName() - Method in interface org.jbpm.api.task.Task

reference to the activity or null if this task is unrelated to an activity

getAssignee() - Method in interface org.jbpm.api.history.HistoryTask

userId of the person that is responsible for this task

getAssignee() - Method in interface org.jbpm.api.task.Swimlane

the userId of the person that is assigned to this swimlane.

getAssignee() - Method in interface org.jbpm.api.task.Task

the person responsible for completion of this task.

getBusinessEmail() - Method in interface org.jbpm.api.identity.User

the email address for the user

getClassLoader() - Method in class org.jbpm.api.Configuration

getCreateTime() - Method in interface org.jbpm.api.history.HistoryTask

time when the activity was entered

getCreateTime() - Method in interface org.jbpm.api.task.Task

date and time when this task was created

getDefaultOutgoingTransition() - Method in interface org.jbpm.api.model.Activity

the default outgoing transition.

getDeploymentId() - Method in interface org.jbpm.api.ProcessDefinition

references the deployment in which this process definition is deployed.

getDescription() - Method in interface org.jbpm.api.ProcessDefinition

description of the process definition

getDescription() - Method in interface org.jbpm.api.task.Task

longer description of this task

getDestination() - Method in interface org.jbpm.api.model.Transition

the activity in which this transition arrives.

getDueDate() - Method in interface org.jbpm.api.job.Job

in case this is a timer, it is the time that the timer should fire, in case this is a message, it is null.

getDuedate() - Method in interface org.jbpm.api.job.Job

Deprecated. call Job.getDueDate() instead

getDuedate() - Method in interface org.jbpm.api.task.Task

date and time when this task must be completed.

getDuration() - Method in interface org.jbpm.api.history.HistoryActivityInstance

duration in milleseconds

getDuration() - Method in interface org.jbpm.api.history.HistoryProcessInstance

duration of the process instance in milliseconds or null if the process instance has not yet ended

getDuration() - Method in interface org.jbpm.api.history.HistoryTask

duration in milliseconds

getEndActivityName() - Method in interface org.jbpm.api.history.HistoryProcessInstance

Returns the name of the end state that was reached when the process was ended.

getEndTime() - Method in interface org.jbpm.api.history.HistoryActivityInstance

might be null in case the activity is still active

getEndTime() - Method in interface org.jbpm.api.history.HistoryProcessInstance

when the process instance ended (only not null if the process instance already ended)

getEndTime() - Method in interface org.jbpm.api.history.HistoryTask

might be null in case the activity is still active

getEventName() - Method in interface org.jbpm.api.job.Timer

the name of the event that is fired on the execution when the timer fires

getException() - Method in interface org.jbpm.api.job.Job

exception that occurred during the last execution of this job.

getExecution(String) - Method in interface org.jbpm.api.Execution

the child execution for the given name or null in case such execution doesn't exist.

getExecution() - Method in interface org.jbpm.api.job.Job

the related execution

getExecution(String) - Method in interface org.jbpm.api.model.OpenExecution

the child execution for the given name or null in case such execution doesn't exist.

getExecutionId() - Method in interface org.jbpm.api.history.HistoryActivityInstance

the execution that was related to this activity occurrence

getExecutionId() - Method in interface org.jbpm.api.history.HistoryTask

the execution that was related to this activity occurrence

getExecutionId() - Method in interface org.jbpm.api.task.Task

reference to the execution or null if this task is unrelated to an execution

getExecutions() - Method in interface org.jbpm.api.Execution

the child executions in the execution structure.

getExecutionService() - Method in interface org.jbpm.api.ProcessEngine

the execution service that provides access to the runtime executions repository.

getExecutionsMap() - Method in interface org.jbpm.api.Execution

maps child execution names to execution objects.

getFamilyName() - Method in interface org.jbpm.api.identity.User

given name (aka last name)

getFormResourceName() - Method in interface org.jbpm.api.task.Task

name of the resource in the deployment for the form that is associated to this task.

getGivenName() - Method in interface org.jbpm.api.identity.User

given name (aka first name)

getGroupId() - Method in interface org.jbpm.api.task.Participation

groupId for this participation.

getHeight() - Method in interface org.jbpm.api.model.ActivityCoordinates

getHistoryService() - Method in interface org.jbpm.api.ProcessEngine

the history service that provides access to the history executions repository.

getId() - Method in interface org.jbpm.api.Deployment

unique identification of this deployment that is used as a reference in the service methods

getId() - Method in interface org.jbpm.api.Execution

a globally unique identifier for this execution that is used as a reference in the service methods.

getId() - Method in interface org.jbpm.api.history.HistoryDetail

the unique id for this comment that is used as a reference in the service methods

getId() - Method in interface org.jbpm.api.history.HistoryTask

the unique id for this task that is used as a reference in the service methods

getId() - Method in interface org.jbpm.api.identity.Group

unique id for the group that is used as a reference in the service methods

getId() - Method in interface org.jbpm.api.identity.User

unique id for the user that is used as a reference in the service methods

getId() - Method in interface org.jbpm.api.job.Job

unique id for this job that is used as a reference in the service methods

getId() - Method in interface org.jbpm.api.ProcessDefinition

the unique id for this process definition that is used as a reference in the service methods.

getId() - Method in interface org.jbpm.api.task.Participation

the unique id for this participation that is used as a reference in the service methods

getId() - Method in interface org.jbpm.api.task.Swimlane

the unique id for this swimlane that is used as a reference in the service methods

getId() - Method in interface org.jbpm.api.task.Task

the unique id for this task that is used as a reference in the service methods

getIdentityService() - Method in interface org.jbpm.api.ProcessEngine

the identity service that exposes the user and group operations management operations.

getImageResourceName() - Method in interface org.jbpm.api.ProcessDefinition

the name of the resource in the deployment which contains the image file for this process

getIncomingTransitions() - Method in interface org.jbpm.api.model.Activity

the list of arriving transitions.

getIsProcessInstance() - Method in interface org.jbpm.api.Execution

Returns whether this execution is a process instance.

getKey() - Method in interface org.jbpm.api.Execution

the optional user provided business key that is unique within one process definition.

getKey() - Method in interface org.jbpm.api.history.HistoryProcessInstance

unique user provided business key (could be null if no such key is provided in ExecutionService.startProcessInstanceById(String, java.util.Map, String))

getKey() - Method in interface org.jbpm.api.ProcessDefinition

the user defined short representation of the name.

getLockExpirationTime() - Method in interface org.jbpm.api.job.Job

getLockOwner() - Method in interface org.jbpm.api.job.Job

job executor identification that has acquired this job and is going to execute it

getManagementService() - Method in interface org.jbpm.api.ProcessEngine

the management service that exposes the management operations to operators that have to keep the jBPM system up and running.

getMessage() - Method in interface org.jbpm.api.history.HistoryComment

the actual message.

getName() - Method in interface org.jbpm.api.Deployment

typically correspond to the file name or url or some other form of identifying the source archive file for this deployment.

getName() - Method in interface org.jbpm.api.Execution

the externally given name or id of this execution.

getName() - Method in interface org.jbpm.api.identity.Group

name for the group (should be unique within one group type)

getName() - Method in interface org.jbpm.api.model.Activity

the short display name given to this element.

getName() - Method in interface org.jbpm.api.model.Transition

the short display name given to this element.

getName() - Method in interface org.jbpm.api.ProcessDefinition

the short display name given to this process definition.

getName() - Method in interface org.jbpm.api.task.Swimlane

the name of the swimlane as defined in the process file

getName() - Method in interface org.jbpm.api.task.Task

the short display name of this task.

getOutcome() - Method in interface org.jbpm.api.history.HistoryTask

the outcome of this task

getOutcomes(String) - Method in interface org.jbpm.api.TaskService

the set of possible valid outcomes for this task.

getOutgoingTransition(String) - Method in interface org.jbpm.api.model.Activity

the first leaving transition with the given name or null of no such leaving transition exists.

getOutgoingTransitions() - Method in interface org.jbpm.api.model.Activity

the list of outgoing transitions.

getOutgoingTransitionsMap() - Method in interface org.jbpm.api.model.Activity

the leaving transitions, keyed by transition name.

getParent() - Method in interface org.jbpm.api.Execution

the parent execution in the execution structure.

getParent() - Method in interface org.jbpm.api.model.OpenExecution

the parent execution in the execution structure.

getParentActivity() - Method in interface org.jbpm.api.model.Activity

retrieve the parent activity in the composite activity structure.

getPriority() - Method in interface org.jbpm.api.Execution

indicates low priorities with negative values and high priorities with positive values.

getPriority() - Method in interface org.jbpm.api.task.Task

the priority of this task.

getProcessDefinitionId() - Method in interface org.jbpm.api.Execution

id of the process definition used for this execution

getProcessDefinitionId() - Method in interface org.jbpm.api.history.HistoryProcessInstance

reference to the process definition

getProcessEngine() - Static method in class org.jbpm.api.Configuration

get the singleton ProcessEngine that is created from the default configuration file 'jbpm.cfg.xml'.

getProcessInstance() - Method in interface org.jbpm.api.Execution

the main path of execution in the execution structure.

getProcessInstance() - Method in interface org.jbpm.api.job.Job

the related process instance

getProcessInstance() - Method in interface org.jbpm.api.model.OpenExecution

the main path of execution in the execution tree structure.

getProcessInstanceId() - Method in interface org.jbpm.api.history.HistoryProcessInstance

the process instance id (== the root execution id)

getProgress() - Method in interface org.jbpm.api.task.Task

The progress of this task.

getRepeat() - Method in interface org.jbpm.api.job.Timer

indicates the delay for repeating this timer after successful execution

getReplies() - Method in interface org.jbpm.api.history.HistoryComment

threaded replies to this comment

getRepositoryService() - Method in interface org.jbpm.api.ProcessEngine

the repository service that provides access to the process repository.

getResourceAsStream(String, String) - Method in interface org.jbpm.api.RepositoryService

obtain an InputStream to a resource in a deployment

getResourceNames(String) - Method in interface org.jbpm.api.RepositoryService

Returns all the resources stored in the deployment with the given id.

getRetries() - Method in interface org.jbpm.api.job.Job

number of retries left.

getSignalName() - Method in interface org.jbpm.api.job.Timer

the signal that sent to the execution when the timer fires

getSource() - Method in interface org.jbpm.api.model.Transition

the activity from which this transition leaves.

getStartActivityNames(String) - Method in interface org.jbpm.api.RepositoryService

find all the activity names of the start activities for a given process definition.

getStartFormResourceName(String, String) - Method in interface org.jbpm.api.RepositoryService

the resource name for the given start activity.

getStartTime() - Method in interface org.jbpm.api.history.HistoryActivityInstance

time when the activity was entered

getStartTime() - Method in interface org.jbpm.api.history.HistoryProcessInstance

when the process instance started

getState() - Method in interface org.jbpm.api.Deployment

Deployment.STATE_ACTIVE or Deployment.STATE_SUSPENDED

getState() - Method in interface org.jbpm.api.Execution

the state of this execution.

getState() - Method in interface org.jbpm.api.history.HistoryProcessInstance

HistoryProcessInstance.STATE_ACTIVE or HistoryProcessInstance.STATE_ENDED (this more coarse grained state then Execution.getState())

getState() - Method in interface org.jbpm.api.history.HistoryTask

history task state

getSubProcessInstance() - Method in interface org.jbpm.api.Execution

the sub path of execution in the execution structure.

getSubProcessInstance() - Method in interface org.jbpm.api.model.OpenExecution

the related sub process execution.

getSubTasks(String) - Method in interface org.jbpm.api.TaskService

get the subtasks for this task.

getTask(String) - Method in interface org.jbpm.api.TaskService

Retrieves the task with the given identifier from persistent storage.

getTaskComments(String) - Method in interface org.jbpm.api.TaskService

get the list of comments made to a task.

getTaskParticipations(String) - Method in interface org.jbpm.api.TaskService

get roles related to a given task.

getTaskService() - Method in interface org.jbpm.api.ProcessEngine

the task service that exposes the runtime human task lists.

getTime() - Method in interface org.jbpm.api.history.HistoryDetail

time that specifies when the comment was made

getTimestamp() - Method in interface org.jbpm.api.Deployment

the timestamp can optionally be given and represents the last updated timestamp of the archive file that is being deployed.

getTransitionNames() - Method in interface org.jbpm.api.history.HistoryActivityInstance

The names of the transitions that were selected as outgoing transitions for the execution.

getType() - Method in interface org.jbpm.api.identity.Group

type or category of the group

getType() - Method in interface org.jbpm.api.model.Activity

the type of this activity which corresponds to the xml tag

getType() - Method in interface org.jbpm.api.task.Participation

see constants for default participations

getUserId() - Method in interface org.jbpm.api.history.HistoryDetail

the id of the user that made this comment.

getUserId() - Method in interface org.jbpm.api.task.Participation

userId for this participation.

getVariable(String, String) - Method in interface org.jbpm.api.ExecutionService

retrieves a variable

getVariable(String, String) - Method in interface org.jbpm.api.HistoryService

retrieves a map of variables

getVariable(String) - Method in interface org.jbpm.api.model.OpenExecution

retrieve the value for the given key.

getVariable(String, String) - Method in interface org.jbpm.api.TaskService

retrieves a variable

getVariableKeys() - Method in interface org.jbpm.api.model.OpenExecution

a non-null set that contains all the keys present in this scope.

getVariableNames(String) - Method in interface org.jbpm.api.ExecutionService

all the variables visible in the given execution scope

getVariableNames(String) - Method in interface org.jbpm.api.HistoryService

retrieves a variable

getVariableNames(String) - Method in interface org.jbpm.api.TaskService

all the variables visible in the given task

getVariables(String, Set<String>) - Method in interface org.jbpm.api.ExecutionService

retrieves a map of variables

getVariables(String, Set<String>) - Method in interface org.jbpm.api.HistoryService

all the variables visible in the given history execution scope

getVariables() - Method in interface org.jbpm.api.model.OpenExecution

a non-null map containing all the key-value pairs in this scope.

getVariables(String, Set<String>) - Method in interface org.jbpm.api.TaskService

retrieves a map of variables

getVersion() - Method in interface org.jbpm.api.ProcessDefinition

automatically assigned during deployment of a process that represents the sequence number for process definitions with the same name.

getWidth() - Method in interface org.jbpm.api.model.ActivityCoordinates

getX() - Method in interface org.jbpm.api.model.ActivityCoordinates

getY() - Method in interface org.jbpm.api.model.ActivityCoordinates

Group - Interface in org.jbpm.api.identity

a group of users.

H

hasActivities() - Method in interface org.jbpm.api.model.Activity

indicates if this processDefinition has activities.

hasActivity(String) - Method in interface org.jbpm.api.model.Activity

indicates if an activity with the given name exists directly in this element.

hasExecution(String) - Method in interface org.jbpm.api.Execution

indicates if this execution has a child execution with the given executionName

hasIncomingTransitions() - Method in interface org.jbpm.api.model.Activity

indicates if this activity has arriving transitions

hasOutgoingTransition(String) - Method in interface org.jbpm.api.model.Activity

indicates if a leaving transition with the given transitionName exists.

hasOutgoingTransitions() - Method in interface org.jbpm.api.model.Activity

indicates if this activity has leaving transitions

hasVariable(String) - Method in interface org.jbpm.api.model.OpenExecution

indicates presenve of the given key.

hasVariables() - Method in interface org.jbpm.api.model.OpenExecution

indicates if there are keys in this scope.

HistoryActivityInstance - Interface in org.jbpm.api.history

represents one occurrence of an activity during a process instance.

HistoryActivityInstanceQuery - Interface in org.jbpm.api.history

query for activity occurrences.

HistoryComment - Interface in org.jbpm.api.history

a free text comment that can be made to an Execution or a task.

HistoryDetail - Interface in org.jbpm.api.history

base type for all history details.

HistoryDetailQuery - Interface in org.jbpm.api.history

query for task comments, task assignments and so on.

HistoryProcessInstance - Interface in org.jbpm.api.history

one particular instance of a process definition.

HistoryProcessInstanceQuery - Interface in org.jbpm.api.history

query for ongoing and finished process instances.

HistoryService - Interface in org.jbpm.api

exposes the history information for ongoing and past process instances.

HistoryTask - Interface in org.jbpm.api.history

history record for a task instance.

HistoryTaskQuery - Interface in org.jbpm.api.history

query for history tasks.

I

IdentityService - Interface in org.jbpm.api

interface to expose the (configurable) identity component that is used by jBPM.

instantiate(String) - Method in class org.jbpm.api.Configuration

isActive(String) - Method in interface org.jbpm.api.Execution

is the given activity active.

isEnded() - Method in interface org.jbpm.api.Execution

is this execution ended

isExclusive() - Method in interface org.jbpm.api.job.Job

indicates if this job should be executed separate from any other job in the same process instance

isSuspended() - Method in interface org.jbpm.api.Execution

is this execution suspended ?

isSuspended() - Method in interface org.jbpm.api.ProcessDefinition

Returns whether this process definition is currently suspended.

J

JbpmException - Exception in org.jbpm.api

all exceptions that jBPM throws are JbpmException's (extends RuntimeException).

JbpmException() - Constructor for exception org.jbpm.api.JbpmException

JbpmException(String, Throwable) - Constructor for exception org.jbpm.api.JbpmException

JbpmException(String) - Constructor for exception org.jbpm.api.JbpmException

JbpmException(Throwable) - Constructor for exception org.jbpm.api.JbpmException

Job - Interface in org.jbpm.api.job

base class for timers and messages.

JobQuery - Interface in org.jbpm.api

query for jBPM related messages and timers.

L

list() - Method in interface org.jbpm.api.DeploymentQuery

execute the query and get the result list

list() - Method in interface org.jbpm.api.history.HistoryActivityInstanceQuery

execute the query and obtain the list of HistoryActivityInstances

list() - Method in interface org.jbpm.api.history.HistoryDetailQuery

execute the query and obtain the list of HistoryDetails

list() - Method in interface org.jbpm.api.history.HistoryProcessInstanceQuery

execute the query and obtain the list of HistoryProcessInstances

list() - Method in interface org.jbpm.api.history.HistoryTaskQuery

execute the query and obtain the list of HistoryTasks

list() - Method in interface org.jbpm.api.JobQuery

execute the query and get the result list

list() - Method in interface org.jbpm.api.ProcessDefinitionQuery

execute the query and obtain the list of ProcessDefinitions

list() - Method in interface org.jbpm.api.ProcessInstanceQuery

execute the query and obtain the list of ProcessInstances

list() - Method in interface org.jbpm.api.TaskQuery

execute the query and obtain the list of Tasks

M

ManagementService - Interface in org.jbpm.api

operations targeted to system operators that need to keep the process engine up and running.

Message - Interface in org.jbpm.api.job

an asynchronous message.

messages() - Method in interface org.jbpm.api.JobQuery

only select messages

N

NewDeployment - Interface in org.jbpm.api

extends a Deployment with method for creating a new deployment.

newTask() - Method in interface org.jbpm.api.TaskService

Creates a task.

newTask(String) - Method in interface org.jbpm.api.TaskService

Creates a new subtask for the given task.

notify(EventListenerExecution) - Method in interface org.jbpm.api.listener.EventListener

is invoked when an execution crosses the event on which this listener is registered

notSuspended() - Method in interface org.jbpm.api.DeploymentQuery

only select non-suspended deployments

notSuspended() - Method in interface org.jbpm.api.ProcessDefinitionQuery

select only process definitions that are not suspended

notSuspended() - Method in interface org.jbpm.api.ProcessInstanceQuery

select only process definitions that are not suspended

notSuspended() - Method in interface org.jbpm.api.TaskQuery

only select tasks that are not suspended

O

OpenExecution - Interface in org.jbpm.api.model

execution that opens up access to the related objects in the execution and process definition model.

OpenProcessInstance - Interface in org.jbpm.api.model

process instance for which the relations are exposed.

orderAsc(String) - Method in interface org.jbpm.api.DeploymentQuery

order results ascending for property DeploymentQuery.PROPERTY_TIMESTAMP or DeploymentQuery.PROPERTY_STATE

orderAsc(String) - Method in interface org.jbpm.api.history.HistoryActivityInstanceQuery

order selected activity instances ascending for certain properties

orderAsc(String) - Method in interface org.jbpm.api.history.HistoryDetailQuery

order selected process definitions ascending

orderAsc(String) - Method in interface org.jbpm.api.history.HistoryProcessInstanceQuery

order selected process instances ascending for certain properties

orderAsc(String) - Method in interface org.jbpm.api.history.HistoryTaskQuery

order selected history tasks ascending for certain properties

orderAsc(String) - Method in interface org.jbpm.api.JobQuery

order ascending for property JobQuery.PROPERTY_STATE or JobQuery.PROPERTY_DUEDATE

orderAsc(String) - Method in interface org.jbpm.api.ProcessDefinitionQuery

order selected process definitions ascending for certain properties

orderAsc(String) - Method in interface org.jbpm.api.ProcessInstanceQuery

order selected process instances ascending for certain properties

orderAsc(String) - Method in interface org.jbpm.api.TaskQuery

order selected tasks ascending for certain properties

orderDesc(String) - Method in interface org.jbpm.api.DeploymentQuery

order results descending for property DeploymentQuery.PROPERTY_TIMESTAMP or DeploymentQuery.PROPERTY_STATE

orderDesc(String) - Method in interface org.jbpm.api.history.HistoryActivityInstanceQuery

order selected process definitions descending for certain properties

orderDesc(String) - Method in interface org.jbpm.api.history.HistoryDetailQuery

order selected process definitions descending

orderDesc(String) - Method in interface org.jbpm.api.history.HistoryProcessInstanceQuery

order selected process instances ascending for certain properties

orderDesc(String) - Method in interface org.jbpm.api.history.HistoryTaskQuery

order selected process definitions descending for certain properties

orderDesc(String) - Method in interface org.jbpm.api.JobQuery

order descending for property JobQuery.PROPERTY_STATE or JobQuery.PROPERTY_DUEDATE

orderDesc(String) - Method in interface org.jbpm.api.ProcessDefinitionQuery

order selected process definitions descending for certain properties

orderDesc(String) - Method in interface org.jbpm.api.ProcessInstanceQuery

order selected process instances descending for certain properties

orderDesc(String) - Method in interface org.jbpm.api.TaskQuery

order selected tasks descending for certain properties

org.jbpm.api - package org.jbpm.api

the jBPM API, Start by creating a Configuration, build a ProcessEngine from that, and then you can find the workflow methods on the services like ExecutionService, TaskService.

org.jbpm.api.activity - package org.jbpm.api.activity

interfaces for implementing customized runtime behaviour of activities.

org.jbpm.api.cmd - package org.jbpm.api.cmd

org.jbpm.api.history - package org.jbpm.api.history

interfaces related to the HistoryService.

org.jbpm.api.identity - package org.jbpm.api.identity

User and Group interfaces related to the IdentityService

org.jbpm.api.job - package org.jbpm.api.job

Job, Message and Timer interfaces related to the ManagementService

org.jbpm.api.jpdl - package org.jbpm.api.jpdl

specific jPDL interfaces

org.jbpm.api.listener - package org.jbpm.api.listener

interfaces for implementing event listeners, which represent runtime behaviour that can be associated as listeners to process events.

org.jbpm.api.model - package org.jbpm.api.model

common process execution model interfaces used in services and delegation interfaces like ActivityBehaviour and EventListener.

org.jbpm.api.task - package org.jbpm.api.task

interfaces related to the TaskService

outcome(String) - Method in interface org.jbpm.api.history.HistoryTaskQuery

only select history tasks that have the given outcome

OWNER - Static variable in interface org.jbpm.api.task.Participation

the person with ultimate responsibility over a task.

P

page(int, int) - Method in interface org.jbpm.api.DeploymentQuery

only select a specific page

page(int, int) - Method in interface org.jbpm.api.history.HistoryActivityInstanceQuery

select a specific page in the result set

page(int, int) - Method in interface org.jbpm.api.history.HistoryDetailQuery

select a specific page in the result set

page(int, int) - Method in interface org.jbpm.api.history.HistoryProcessInstanceQuery

select a specific page in the result set

page(int, int) - Method in interface org.jbpm.api.history.HistoryTaskQuery

select a specific page in the result set

page(int, int) - Method in interface org.jbpm.api.JobQuery

only select a specific page

page(int, int) - Method in interface org.jbpm.api.ProcessDefinitionQuery

select a specific page in the result set

page(int, int) - Method in interface org.jbpm.api.ProcessInstanceQuery

select a specific page in the result set

page(int, int) - Method in interface org.jbpm.api.TaskQuery

select a specific page in the result set

ParamCommand<T> - Class in org.jbpm.api.cmd

command with support for parameter passing from the client to the implementation.

ParamCommand() - Constructor for class org.jbpm.api.cmd.ParamCommand

params - Variable in class org.jbpm.api.cmd.ParamCommand

Participation - Interface in org.jbpm.api.task

a link to a participating identity (user or group) and the type of involvement.

ProcessDefinition - Interface in org.jbpm.api

a graphical process which is deployed in the RepositoryService.

processDefinitionId(String) - Method in interface org.jbpm.api.history.HistoryActivityInstanceQuery

only select activity instances for the given process definition

processDefinitionId(String) - Method in interface org.jbpm.api.history.HistoryProcessInstanceQuery

select only process instances with the given process definition

processDefinitionId(String) - Method in interface org.jbpm.api.ProcessDefinitionQuery

select only the process definition with the given id

processDefinitionId(String) - Method in interface org.jbpm.api.ProcessInstanceQuery

select only process instances for the given process definition

processDefinitionId(String) - Method in interface org.jbpm.api.TaskQuery

only select tasks that are associated to the given process definition

processDefinitionKey(String) - Method in interface org.jbpm.api.ProcessDefinitionQuery

select only process definitions with the given key

processDefinitionName(String) - Method in interface org.jbpm.api.ProcessDefinitionQuery

select only process definitions with an exact match for the given name

processDefinitionNameLike(String) - Method in interface org.jbpm.api.ProcessDefinitionQuery

select only process definitions with a name like the given name (name can include % signs to act as wildcard))

ProcessDefinitionQuery - Interface in org.jbpm.api

query for process definitions.

ProcessEngine - Interface in org.jbpm.api

central starting point for all process engine API interactions.

ProcessInstance - Interface in org.jbpm.api

a process instance is one execution of a process definition.

processInstanceId(String) - Method in interface org.jbpm.api.history.HistoryActivityInstanceQuery

only select activity instances for the given process instance id

processInstanceId(String) - Method in interface org.jbpm.api.history.HistoryDetailQuery

only select details for the given processInstanceId

processInstanceId(String) - Method in interface org.jbpm.api.history.HistoryProcessInstanceQuery

select only the process instances with the given id

processInstanceId(String) - Method in interface org.jbpm.api.JobQuery

only select jobs related to the given process instance

processInstanceId(String) - Method in interface org.jbpm.api.ProcessInstanceQuery

select only a specific process instances using the process instance id

processInstanceId(String) - Method in interface org.jbpm.api.TaskQuery

only select tasks that are associated to the given process instance

processInstanceKey(String) - Method in interface org.jbpm.api.history.HistoryProcessInstanceQuery

select only process instances with the given business key

processInstanceKey(String) - Method in interface org.jbpm.api.ProcessInstanceQuery

select only specific process instances using a business key

ProcessInstanceQuery - Interface in org.jbpm.api

query for ongoing process instances exclusively. refer to HistoryProcessInstanceQuery for queries that include finished process instances.

PROPERTY_ACTIVITYNAME - Static variable in interface org.jbpm.api.history.HistoryActivityInstanceQuery

activityName property to be used as property in HistoryActivityInstanceQuery.orderAsc(String) and HistoryActivityInstanceQuery.orderDesc(String)

PROPERTY_ASSIGNEE - Static variable in interface org.jbpm.api.history.HistoryTaskQuery

outcome property to be used as property in orderAsc(String) and orderDesc(String)

PROPERTY_ASSIGNEE - Static variable in interface org.jbpm.api.TaskQuery

assignee property to be used as property in TaskQuery.orderAsc(String) and TaskQuery.orderDesc(String)

PROPERTY_CREATEDATE - Static variable in interface org.jbpm.api.TaskQuery

createdate property to be used as property in TaskQuery.orderAsc(String) and TaskQuery.orderDesc(String)

PROPERTY_CREATETIME - Static variable in interface org.jbpm.api.history.HistoryTaskQuery

starttime property to be used as property in orderAsc(String) and orderDesc(String)

PROPERTY_DEPLOYMENT_TIMESTAMP - Static variable in interface org.jbpm.api.ProcessDefinitionQuery

timestamp property to be used as property in ProcessDefinitionQuery.orderAsc(String) and ProcessDefinitionQuery.orderDesc(String)

PROPERTY_DUEDATE - Static variable in interface org.jbpm.api.JobQuery

duedate property to be used as property in JobQuery.orderAsc(String) and JobQuery.orderDesc(String)

PROPERTY_DUEDATE - Static variable in interface org.jbpm.api.TaskQuery

duedate property to be used as property in TaskQuery.orderAsc(String) and TaskQuery.orderDesc(String)

PROPERTY_DURATION - Static variable in interface org.jbpm.api.history.HistoryActivityInstanceQuery

duration property to be used as property in HistoryActivityInstanceQuery.orderAsc(String) and HistoryActivityInstanceQuery.orderDesc(String)

PROPERTY_DURATION - Static variable in interface org.jbpm.api.history.HistoryProcessInstanceQuery

duration property to be used as property in HistoryProcessInstanceQuery.orderAsc(String) and HistoryProcessInstanceQuery.orderDesc(String)

PROPERTY_DURATION - Static variable in interface org.jbpm.api.history.HistoryTaskQuery

duration property to be used as property in orderAsc(String) and orderDesc(String)

PROPERTY_ENDTIME - Static variable in interface org.jbpm.api.history.HistoryActivityInstanceQuery

endtime property to be used as property in HistoryActivityInstanceQuery.orderAsc(String) and HistoryActivityInstanceQuery.orderDesc(String)

PROPERTY_ENDTIME - Static variable in interface org.jbpm.api.history.HistoryProcessInstanceQuery

endtime property to be used as property in HistoryProcessInstanceQuery.orderAsc(String) and HistoryProcessInstanceQuery.orderDesc(String)

PROPERTY_ENDTIME - Static variable in interface org.jbpm.api.history.HistoryTaskQuery

endtime property to be used as property in orderAsc(String) and orderDesc(String)

PROPERTY_EXECUTIONID - Static variable in interface org.jbpm.api.history.HistoryActivityInstanceQuery

executionId property to be used as property in HistoryActivityInstanceQuery.orderAsc(String) and HistoryActivityInstanceQuery.orderDesc(String)

PROPERTY_EXECUTIONID - Static variable in interface org.jbpm.api.history.HistoryTaskQuery

executionId property to be used as property in orderAsc(String) and orderDesc(String)

PROPERTY_ID - Static variable in interface org.jbpm.api.history.HistoryProcessInstanceQuery

id property to be used as property in HistoryProcessInstanceQuery.orderAsc(String) and HistoryProcessInstanceQuery.orderDesc(String)

PROPERTY_ID - Static variable in interface org.jbpm.api.history.HistoryTaskQuery

id property to be used as property in orderAsc(String) and orderDesc(String)

PROPERTY_ID - Static variable in interface org.jbpm.api.ProcessDefinitionQuery

id property to be used as property in ProcessDefinitionQuery.orderAsc(String) and ProcessDefinitionQuery.orderDesc(String)

PROPERTY_KEY - Static variable in interface org.jbpm.api.history.HistoryProcessInstanceQuery

Key propertu to be used as property in HistoryProcessInstanceQuery.orderAsc(String) and HistoryProcessInstanceQuery.orderDesc(String)

PROPERTY_KEY - Static variable in interface org.jbpm.api.ProcessDefinitionQuery

key property to be used as property in ProcessDefinitionQuery.orderAsc(String) and ProcessDefinitionQuery.orderDesc(String)

PROPERTY_KEY - Static variable in interface org.jbpm.api.ProcessInstanceQuery

key property to be used as property in ProcessInstanceQuery.orderAsc(String) and ProcessInstanceQuery.orderDesc(String)

PROPERTY_NAME - Static variable in interface org.jbpm.api.ProcessDefinitionQuery

name property to be used as property in ProcessDefinitionQuery.orderAsc(String) and ProcessDefinitionQuery.orderDesc(String)

PROPERTY_NAME - Static variable in interface org.jbpm.api.TaskQuery

name property to be used as property in TaskQuery.orderAsc(String) and TaskQuery.orderDesc(String)

PROPERTY_OUTCOME - Static variable in interface org.jbpm.api.history.HistoryTaskQuery

outcome property to be used as property in orderAsc(String) and orderDesc(String)

PROPERTY_PRIORITY - Static variable in interface org.jbpm.api.TaskQuery

priority property to be used as property in TaskQuery.orderAsc(String) and TaskQuery.orderDesc(String)

PROPERTY_PROGRESS - Static variable in interface org.jbpm.api.TaskQuery

progress property to be used as property in TaskQuery.orderAsc(String) and TaskQuery.orderDesc(String)

PROPERTY_STARTTIME - Static variable in interface org.jbpm.api.history.HistoryActivityInstanceQuery

starttime property to be used as property in HistoryActivityInstanceQuery.orderAsc(String) and HistoryActivityInstanceQuery.orderDesc(String)

PROPERTY_STARTTIME - Static variable in interface org.jbpm.api.history.HistoryProcessInstanceQuery

starttime property to be used as property in HistoryProcessInstanceQuery.orderAsc(String) and HistoryProcessInstanceQuery.orderDesc(String)

PROPERTY_STATE - Static variable in interface org.jbpm.api.DeploymentQuery

PROPERTY_STATE - Static variable in interface org.jbpm.api.history.HistoryProcessInstanceQuery

state property to be used as property in HistoryProcessInstanceQuery.orderAsc(String) and HistoryProcessInstanceQuery.orderDesc(String)

PROPERTY_STATE - Static variable in interface org.jbpm.api.history.HistoryTaskQuery

state property to be used as property in orderAsc(String) and orderDesc(String)

PROPERTY_STATE - Static variable in interface org.jbpm.api.JobQuery

state property to be used as property in JobQuery.orderAsc(String) and JobQuery.orderDesc(String)

PROPERTY_TIME - Static variable in interface org.jbpm.api.history.HistoryDetailQuery

time property to be used as property in HistoryDetailQuery.orderAsc(String) and HistoryDetailQuery.orderDesc(String)

PROPERTY_TIMESTAMP - Static variable in interface org.jbpm.api.DeploymentQuery

PROPERTY_USERID - Static variable in interface org.jbpm.api.history.HistoryDetailQuery

userId property to be used as property in HistoryDetailQuery.orderAsc(String) and HistoryDetailQuery.orderDesc(String)

PROPERTY_VERSION - Static variable in interface org.jbpm.api.ProcessDefinitionQuery

version property to be used as property in ProcessDefinitionQuery.orderAsc(String) and ProcessDefinitionQuery.orderDesc(String)

R

REMIND - Static variable in interface org.jbpm.api.model.Event

fired when an assignee is reminded of a task

removeTaskParticipatingGroup(String, String, String) - Method in interface org.jbpm.api.TaskService

removes a role to a given task.

removeTaskParticipatingUser(String, String, String) - Method in interface org.jbpm.api.TaskService

removes a role to a given task.

removeVariable(String) - Method in interface org.jbpm.api.model.OpenExecution

remove the key-value pair for the given key from this scope.

removeVariables() - Method in interface org.jbpm.api.model.OpenExecution

removes all variables in this scope

REPLACED_ASSIGNEE - Static variable in interface org.jbpm.api.task.Participation

a person that was assigned to a task, but got replaced because of absence or another reason.

RepositoryService - Interface in org.jbpm.api

exposes the repository of deployments.

resumeDeployment(String) - Method in interface org.jbpm.api.RepositoryService

resume a suspended deployment.

S

saveTask(Task) - Method in interface org.jbpm.api.TaskService

Saves the given task to persistent storage.

setAssignee(String) - Method in interface org.jbpm.api.task.Assignable

assign the task or swimlane to the given user

setAssignee(String) - Method in interface org.jbpm.api.task.Task

update the assignee of this task.

setAuthenticatedUserId(String) - Method in interface org.jbpm.api.ProcessEngine

sets the authenticated user's id for the next invocation of a service method in the same thread.

setDescription(String) - Method in interface org.jbpm.api.task.Task

update the longer description of this task.

setDuedate(Date) - Method in interface org.jbpm.api.task.Task

update the date and time when this task must be completed.

setFile(File) - Method in class org.jbpm.api.Configuration

provide a File as the configuration file

setHibernateSession(Object) - Method in interface org.jbpm.api.ProcessEngine

sets the hibernate session for the next invocation of a service method in the same thread.

setHibernateSessionFactory(Object) - Method in class org.jbpm.api.Configuration

provides the hibernate session factory programmatically.

setInputSource(InputSource) - Method in class org.jbpm.api.Configuration

provide a sax input source as the configuration resource

setInputStream(InputStream) - Method in class org.jbpm.api.Configuration

provide an input stream as the configuration resource

setJdbcConnection(Connection) - Method in interface org.jbpm.api.ProcessEngine

sets the hibernate session for the next invocation of a service method in the same thread.

setName(String) - Method in interface org.jbpm.api.NewDeployment

typically correspond to the file name or url or some other form of identifying the source archive file for this deployment.

setName(String) - Method in interface org.jbpm.api.task.Task

change the short display name of this tasks.

setParam(String, Object) - Method in class org.jbpm.api.cmd.ParamCommand

setPriority(int) - Method in interface org.jbpm.api.activity.ActivityExecution

setter for the priority.

setPriority(int) - Method in interface org.jbpm.api.listener.EventListenerExecution

setter for the priority.

setPriority(int) - Method in interface org.jbpm.api.model.OpenExecution

setter for the priority.

setPriority(int) - Method in interface org.jbpm.api.task.Task

update the priority.

setProgress(Integer) - Method in interface org.jbpm.api.task.Task

Change the progress of this task.

setResource(String) - Method in class org.jbpm.api.Configuration

provide an classpath resource as the configuration file

setState(String) - Method in interface org.jbpm.api.model.OpenExecution

update the state

setTimestamp(long) - Method in interface org.jbpm.api.NewDeployment

the timestamp can optionally be given and represents the last updated timestamp of the archive file that is being deployed.

setUrl(URL) - Method in class org.jbpm.api.Configuration

point with a url to the configuration file

setVariable(String, String, Object) - Method in interface org.jbpm.api.ExecutionService

creates or overwrites a variable value in the referenced execution

setVariable(String, Object) - Method in interface org.jbpm.api.model.OpenExecution

updates or creates a variable for the given value.

setVariables(String, Map<String, ?>) - Method in interface org.jbpm.api.ExecutionService

creates or overwrites variable values in the referenced execution

setVariables(Map<String, ?>) - Method in interface org.jbpm.api.model.OpenExecution

sets all given variables.

setVariables(String, Map<String, ?>) - Method in interface org.jbpm.api.TaskService

creates or overwrites the variable values on the given task

setXmlString(String) - Method in class org.jbpm.api.Configuration

provide an xml string as the configuration resource

signal(ActivityExecution, String, Map<String, ?>) - Method in interface org.jbpm.api.activity.ExternalActivityBehaviour

handles an external signal.

signalExecutionById(String) - Method in interface org.jbpm.api.ExecutionService

provides an external trigger to an execution.

signalExecutionById(String, String) - Method in interface org.jbpm.api.ExecutionService

provides a named external trigger to an execution.

signalExecutionById(String, String, Map<String, ?>) - Method in interface org.jbpm.api.ExecutionService

provides a named external trigger to an execution with parameters.

signalExecutionById(String, Map<String, ?>) - Method in interface org.jbpm.api.ExecutionService

provides a external trigger to an execution with parameters.

START - Static variable in interface org.jbpm.api.model.Event

fired when a process or an activity starts

startedAfter(Date) - Method in interface org.jbpm.api.history.HistoryActivityInstanceQuery

only select activity instances started after the given time

startedAfter(Date) - Method in interface org.jbpm.api.history.HistoryTaskQuery

only select history tasks started after the given time

startedBefore(Date) - Method in interface org.jbpm.api.history.HistoryActivityInstanceQuery

only select activity instances started before the given time

startedBefore(Date) - Method in interface org.jbpm.api.history.HistoryTaskQuery

only select history tasks started before the given time

startProcessInstanceById(String) - Method in interface org.jbpm.api.ExecutionService

starts a new process instance for the ProcessDefinition with the given processDefinitionDbid.

startProcessInstanceById(String, String) - Method in interface org.jbpm.api.ExecutionService

starts a new process instance for the ProcessDefinition with the given processDefinitionDbid.

startProcessInstanceById(String, Map<String, ?>) - Method in interface org.jbpm.api.ExecutionService

starts a new process instance for the ProcessDefinition with the given processDefinitionDbid.

startProcessInstanceById(String, Map<String, ?>, String) - Method in interface org.jbpm.api.ExecutionService

starts a new process instance for the ProcessDefinition with the given processDefinitionDbid.

startProcessInstanceByKey(String) - Method in interface org.jbpm.api.ExecutionService

starts a new process instance in the latest version of the given process definition.

startProcessInstanceByKey(String, String) - Method in interface org.jbpm.api.ExecutionService

starts a new process instance in the latest version of the given processDefinitionName.

startProcessInstanceByKey(String, Map<String, ?>) - Method in interface org.jbpm.api.ExecutionService

starts a new process instance in the latest version of the given processDefinitionName.

startProcessInstanceByKey(String, Map<String, ?>, String) - Method in interface org.jbpm.api.ExecutionService

starts a new process instance in the latest version of the given processDefinitionName.

state(String) - Method in interface org.jbpm.api.history.HistoryProcessInstanceQuery

select only process instances in the given state

state(String) - Method in interface org.jbpm.api.history.HistoryTaskQuery

only select history tasks in the given state

STATE_ACTIVE - Static variable in interface org.jbpm.api.Deployment

normal deployments for which contained process definitions can be executed.

STATE_ACTIVE - Static variable in interface org.jbpm.api.history.HistoryProcessInstance

when the full process instance is still active

STATE_ACTIVE_CONCURRENT - Static variable in interface org.jbpm.api.Execution

concurrent path of execution that is an active indicator of the current position in the diagram.

STATE_ACTIVE_ROOT - Static variable in interface org.jbpm.api.Execution

single (non-concurrent) path of execution that is an active indicator of the current position in the diagram.

STATE_ASYNC - Static variable in interface org.jbpm.api.Execution

indicates that this execution is doing an asynchronous continuation.

STATE_COMPLETED - Static variable in interface org.jbpm.api.history.HistoryTask

STATE_COMPLETED - Static variable in interface org.jbpm.api.task.Task

task is done

STATE_CREATED - Static variable in interface org.jbpm.api.Execution

between creation of a new process instance and the start of that process instance.

STATE_ENDED - Static variable in interface org.jbpm.api.Execution

this execution has ended.

STATE_ENDED - Static variable in interface org.jbpm.api.history.HistoryProcessInstance

when the full process instance has come to an end

STATE_INACTIVE_CONCURRENT_ROOT - Static variable in interface org.jbpm.api.Execution

parent of concurrent child executions.

STATE_INACTIVE_JOIN - Static variable in interface org.jbpm.api.Execution

concurrent execution that is inactively waiting in a join until other concurrent executions arrive.

STATE_INACTIVE_SCOPE - Static variable in interface org.jbpm.api.Execution

parent of a scoped execution.

STATE_OBSOLETE - Static variable in interface org.jbpm.api.history.HistoryTask

STATE_OPEN - Static variable in interface org.jbpm.api.task.Task

task is waiting for someone to work on it and completed it

STATE_SUSPENDED - Static variable in interface org.jbpm.api.Deployment

invisible for all operations except delete or resume.

STATE_SUSPENDED - Static variable in interface org.jbpm.api.Execution

indicates that this execution is temporary suspended.

STATE_SUSPENDED - Static variable in interface org.jbpm.api.task.Task

task doesn't show up in task lists as something is wrong with the related process instance that requires manual intervention first.

suspendDeployment(String) - Method in interface org.jbpm.api.RepositoryService

similar to deleting a deployment.

suspended() - Method in interface org.jbpm.api.DeploymentQuery

only select suspended deployments

suspended() - Method in interface org.jbpm.api.ProcessDefinitionQuery

select only suspended process definitions

suspended() - Method in interface org.jbpm.api.ProcessInstanceQuery

select only suspended process definitions

suspended() - Method in interface org.jbpm.api.TaskQuery

only select suspended tasks

Swimlane - Interface in org.jbpm.api.task

a runtime process role that can store an assignment so that multiple related tasks are assigned to the same actor.

T

take(String) - Method in interface org.jbpm.api.activity.ActivityExecution

takes the outgoing transition with the given name.

TAKE - Static variable in interface org.jbpm.api.model.Event

fired when a transition is being taken

takeDefaultTransition() - Method in interface org.jbpm.api.activity.ActivityExecution

takes the default transition.

takeTask(String, String) - Method in interface org.jbpm.api.TaskService

taking this task will prevent all other candidates from taking and working on this task.

Task - Interface in org.jbpm.api.task

a runtime task.

taskId(String) - Method in interface org.jbpm.api.history.HistoryDetailQuery

only select details for the given taskId

taskId(String) - Method in interface org.jbpm.api.history.HistoryTaskQuery

only select the history task for the given id

TaskQuery - Interface in org.jbpm.api

query for tasks.

TaskService - Interface in org.jbpm.api

task management.

timeAfter(Date) - Method in interface org.jbpm.api.history.HistoryDetailQuery

only select details after the given time

timeBefore(Date) - Method in interface org.jbpm.api.history.HistoryDetailQuery

only select details before the given time

Timer - Interface in org.jbpm.api.job

a timer.

timers() - Method in interface org.jbpm.api.JobQuery

only select timers

tookLessThen(long) - Method in interface org.jbpm.api.history.HistoryActivityInstanceQuery

only select activity instances that took less then the given duration in milliseconds

tookLessThen(long) - Method in interface org.jbpm.api.history.HistoryTaskQuery

only select history tasks that took less then the given duration in milliseconds

tookLongerThen(long) - Method in interface org.jbpm.api.history.HistoryActivityInstanceQuery

only select activity instances that took longer then the given duration in milliseconds

tookLongerThen(long) - Method in interface org.jbpm.api.history.HistoryTaskQuery

only select history tasks that took longer then the given duration in milliseconds

Transition - Interface in org.jbpm.api.model

a transition in a OpenProcessDefinition graph.

U

unassigned() - Method in interface org.jbpm.api.TaskQuery

only select tasks that are unassigned.

uniqueResult() - Method in interface org.jbpm.api.DeploymentQuery

execute the query and get the unique result

uniqueResult() - Method in interface org.jbpm.api.history.HistoryActivityInstanceQuery

execute the query and obtain the unique HistoryActivityInstance

uniqueResult() - Method in interface org.jbpm.api.history.HistoryDetailQuery

execute the query and obtain the unique HistoryDetail

uniqueResult() - Method in interface org.jbpm.api.history.HistoryProcessInstanceQuery

execute the query and obtain the unique HistoryProcessInstance

uniqueResult() - Method in interface org.jbpm.api.history.HistoryTaskQuery

execute the query and obtain the unique HistoryTask

uniqueResult() - Method in interface org.jbpm.api.JobQuery

execute the query and get the unique result

uniqueResult() - Method in interface org.jbpm.api.ProcessDefinitionQuery

execute the query and obtain the unique ProcessDefinition

uniqueResult() - Method in interface org.jbpm.api.ProcessInstanceQuery

execute the query and obtain the unique ProcessInstance

uniqueResult() - Method in interface org.jbpm.api.TaskQuery

execute the query and obtain the unique Task

User - Interface in org.jbpm.api.identity

a user.

V

VIEWER - Static variable in interface org.jbpm.api.task.Participation

person that is allowed to watch-but-not-touch this task

VoidCommand - Class in org.jbpm.api.cmd

convenience for commands without return value.

VoidCommand() - Constructor for class org.jbpm.api.cmd.VoidCommand

W

waitForSignal() - Method in interface org.jbpm.api.activity.ActivityExecution

makes this execution wait in the current activity until an external trigger is given with one of the signal methods.

A B C D E F G H I J L M N O P R S T U V W