Skip navigation links
jBPM :: Services API 6.5.0.Final-redhat-23
A B C D E F G I L M N O P Q R S T U V W 

A

abortProcessInstance(Long) - Method in interface org.jbpm.services.api.ProcessService
Aborts the specified process
abortProcessInstances(List<Long>) - Method in interface org.jbpm.services.api.ProcessService
Aborts all specified processes
abortWorkItem(Long) - Method in interface org.jbpm.services.api.ProcessService
Abort the specified workItem
accept(String) - Method in interface org.jbpm.services.api.query.QueryParamBuilderFactory
Determines if this factory can build instances with given identifier
activate(String) - Method in interface org.jbpm.services.api.DeploymentService
Activates given deployment by making sure it will be available for execution.
activate(Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Activate the task, i.e. set the task to status Ready.
addAttachment(Long, String, String, Object) - Method in interface org.jbpm.services.api.UserTaskService
Add attachment to a task
addComment(Long, String, String, Date) - Method in interface org.jbpm.services.api.UserTaskService
Add comment to a task
addListener(DeploymentEventListener) - Method in interface org.jbpm.services.api.ListenerSupport
 
addMapper(QueryResultMapper<?>) - Method in class org.jbpm.services.api.query.QueryMapperRegistry
 
addProcessDefinition(String, String, Object, KieContainer) - Method in interface org.jbpm.services.api.DefinitionService
 
addTask(Task, Map<String, Object>) - Method in interface org.jbpm.services.api.AdHocUserTaskService
 
addTask(String, int, Date, List<String>, List<String>, String, String, String, Long, Map<String, Object>, boolean, boolean) - Method in interface org.jbpm.services.api.AdHocUserTaskService
 
AdHocProcessService - Interface in org.jbpm.services.api
Created by salaboy on 06/05/15.
AdHocUserTaskService - Interface in org.jbpm.services.api
 

B

between(String, Comparable<?>, Comparable<?>) - Static method in class org.jbpm.services.api.query.model.QueryParam
 
build() - Method in interface org.jbpm.services.api.query.QueryParamBuilder
Builds single condition per invocation and it is invoked as long as it returns non null value.
buildProcessDefinition(String, String, KieContainer, boolean) - Method in interface org.jbpm.services.api.DefinitionService
Performs build operation for given bpmn2content to produce fully populated ProcessDefinition

C

claim(Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Claim responsibility for a task, i.e. set the task to status Reserved
COLUMN_ACTIVATIONTIME - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_ACTUALOWNER - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_CORRELATIONKEY - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_CREATEDBY - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_CREATEDON - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_DEPLOYMENTID - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_DESCRIPTION - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_DUEDATE - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_DURATION - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_END - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_EXTERNALID - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_IDENTITY - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_JOB_BUSINESSKEY - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_JOB_COMMANDNAME - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_JOB_ID - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_JOB_MESSAGE - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_JOB_STATUS - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_JOB_TIMESTAMP - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_NAME - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_ORGANIZATIONAL_ENTITY - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_OUTCOME - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_PARENTID - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_PARENTPROCESSINSTANCEID - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_PRIORITY - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_PROCESSID - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_PROCESSINSTANCEDESCRIPTION - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_PROCESSINSTANCEID - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_PROCESSNAME - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_PROCESSVERSION - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_START - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_STATUS - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_SUBJECT - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_TASK_PROCESSID - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_TASK_PROCESSINSTANCEID - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_TASK_STATUS - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_TASK_VAR_NAME - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_TASK_VAR_TYPE - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_TASK_VAR_VALUE - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_TASKID - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_VAR_NAME - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_VAR_VALUE - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_WORKITEMID - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
complete(Long, String, Map<String, Object>) - Method in interface org.jbpm.services.api.UserTaskService
Complete a task with the given data
completeAutoProgress(Long, String, Map<String, Object>) - Method in interface org.jbpm.services.api.UserTaskService
Complete a task with the given data.
completeWorkItem(Long, Map<String, Object>) - Method in interface org.jbpm.services.api.ProcessService
Completes the specified WorkItem with the given results

D

deactivate(String) - Method in interface org.jbpm.services.api.DeploymentService
Deactivates given deployment by making it only available for already running instances.
DefinitionService - Interface in org.jbpm.services.api
Provides details from definition point of view which is extracted from BPMN2 definitions.
delegate(Long, String, String) - Method in interface org.jbpm.services.api.UserTaskService
Delegate a task from userId to targetUserId
deleteAttachment(Long, Long) - Method in interface org.jbpm.services.api.UserTaskService
Delete attachment from a task
deleteComment(Long, Long) - Method in interface org.jbpm.services.api.UserTaskService
Deletes comment from a task
deleteContent(Long, Long) - Method in interface org.jbpm.services.api.UserTaskService
Deletes content given by contentId from given task
deploy(DeploymentUnit) - Method in interface org.jbpm.services.api.DeploymentService
Performs deployment operation of given unit.
DeployedAsset - Interface in org.jbpm.services.api.model
 
DeployedUnit - Interface in org.jbpm.services.api.model
 
DeploymentEvent - Class in org.jbpm.services.api
 
DeploymentEvent(String, DeployedUnit) - Constructor for class org.jbpm.services.api.DeploymentEvent
 
DeploymentEventListener - Interface in org.jbpm.services.api
 
DeploymentNotFoundException - Exception in org.jbpm.services.api
 
DeploymentNotFoundException(String) - Constructor for exception org.jbpm.services.api.DeploymentNotFoundException
 
DeploymentNotFoundException(String, Throwable) - Constructor for exception org.jbpm.services.api.DeploymentNotFoundException
 
DeploymentService - Interface in org.jbpm.services.api
Deploys DeploymentUnits into the runtime engine by building RuntimeManager instance for the deployment unit.
DeploymentUnit - Interface in org.jbpm.services.api.model
 
discoverAndAddMappers(ClassLoader) - Method in class org.jbpm.services.api.query.QueryMapperRegistry
Discovers and adds all QueryResultMappers to the known set

E

equalsTo(String, Comparable<?>...) - Static method in class org.jbpm.services.api.query.model.QueryParam
 
execute(String, Command<T>) - Method in interface org.jbpm.services.api.ProcessService
Executes provided command on the underlying command executor (usually KieSession)
execute(String, Context<?>, Command<T>) - Method in interface org.jbpm.services.api.ProcessService
Executes provided command on the underlying command executor (usually KieSession)
execute(String, Command<T>) - Method in interface org.jbpm.services.api.UserTaskService
Executes provided command on the underlying command executor
execute(String, Context<?>, Command<T>) - Method in interface org.jbpm.services.api.UserTaskService
Executes provided command on the underlying command executor
exit(Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Requesting application is no longer interested in the task output

F

fail(Long, String, Map<String, Object>) - Method in interface org.jbpm.services.api.UserTaskService
Actual owner completes the execution of the task raising a fault.
forColumnMapping(Map<String, String>) - Method in class org.jbpm.services.api.query.NamedQueryMapper
 
forColumnMapping(Map<String, String>) - Method in interface org.jbpm.services.api.query.QueryResultMapper
Returns new instance of the mapper for given column mapping
forward(Long, String, String) - Method in interface org.jbpm.services.api.UserTaskService
Forward the task to another organization entity.

G

get() - Static method in class org.jbpm.services.api.query.QueryMapperRegistry
Returns instance of the registry that is already populated with known mappers.
getActivationTime() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
 
getActiveTasks() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
 
getActualOwner() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
 
getAllAdminAuditTask(String, QueryFilter) - Method in interface org.jbpm.services.api.RuntimeDataService
Get a list of tasks admin audit (user in businessAdministrators) logs for the user provides applying the query filter listed statuses.
getAllAuditTask(String, QueryFilter) - Method in interface org.jbpm.services.api.RuntimeDataService
Get a list of tasks audit logs for the user provides applying the query filter listed statuses.
getAllAuditTaskByStatus(String, QueryFilter) - Method in interface org.jbpm.services.api.RuntimeDataService
Get a list of all active tasks audit logs for the user provides applying the query filter listed statuses.
getAllGroupAuditTask(String, QueryFilter) - Method in interface org.jbpm.services.api.RuntimeDataService
Get a list of group tasks (actualOwner == null) audit logs for the user provides applying the query filter listed statuses.
getAssociatedEntities(String, String) - Method in interface org.jbpm.services.api.DefinitionService
Returns all organizational entities identifiers involved in the process - like users and groups.
getAssociatedEntities() - Method in interface org.jbpm.services.api.model.ProcessDefinition
 
getAssociatedEntities() - Method in interface org.jbpm.services.api.model.UserTaskDefinition
 
getAttachmentById(Long, Long) - Method in interface org.jbpm.services.api.UserTaskService
Get attachment by identifier
getAttachmentContentById(Long, Long) - Method in interface org.jbpm.services.api.UserTaskService
Get attachment's content by identifier
getAttachmentsByTaskId(Long) - Method in interface org.jbpm.services.api.UserTaskService
Get attachments for a task
getAvailableSignals(Long) - Method in interface org.jbpm.services.api.ProcessService
Returns all signals available in current state of given process instance
getColumn() - Method in class org.jbpm.services.api.query.model.QueryParam
 
getComment() - Method in interface org.jbpm.services.api.model.UserTaskDefinition
 
getCommentById(Long, Long) - Method in interface org.jbpm.services.api.UserTaskService
Get comment by identifier
getCommentsByTaskId(Long) - Method in interface org.jbpm.services.api.UserTaskService
Get comments for a task
getConnection() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
 
getCorrelationKey() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
 
getCreatedBy() - Method in interface org.jbpm.services.api.model.UserTaskDefinition
 
getCreatedBy() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
 
getCreatedOn() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
 
getDataTimeStamp() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
 
getDataTimeStamp() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
 
getDataTimeStamp() - Method in interface org.jbpm.services.api.model.VariableDesc
 
getDeployedAssetLocation(String) - Method in interface org.jbpm.services.api.model.DeployedUnit
 
getDeployedAssets() - Method in interface org.jbpm.services.api.model.DeployedUnit
 
getDeployedClasses() - Method in interface org.jbpm.services.api.model.DeployedUnit
 
getDeployedUnit() - Method in class org.jbpm.services.api.DeploymentEvent
 
getDeployedUnit(String) - Method in interface org.jbpm.services.api.DeploymentService
Returns DeployedUnit instance for given deployment id if exists
getDeployedUnits() - Method in interface org.jbpm.services.api.DeploymentService
Returns all (currently) deployed units.
getDeploymentId() - Method in class org.jbpm.services.api.DeploymentEvent
 
getDeploymentId() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
 
getDeploymentId() - Method in interface org.jbpm.services.api.model.ProcessDefinition
 
getDeploymentId() - Method in interface org.jbpm.services.api.model.ProcessDesc
 
getDeploymentId() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
 
getDeploymentId() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
 
getDeploymentId() - Method in interface org.jbpm.services.api.model.VariableDesc
 
getDeploymentUnit() - Method in interface org.jbpm.services.api.model.DeployedUnit
 
getDescription() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
 
getDueDate() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
 
getEncodedProcessSource() - Method in interface org.jbpm.services.api.model.ProcessDesc
 
getEndDate() - Method in interface org.jbpm.services.api.admin.MigrationReport
Timestamp representing end time of the migration
getEntries() - Method in interface org.jbpm.services.api.admin.MigrationReport
Returns complete list of migration entries (steps performed) with details about them
getExpression() - Method in interface org.jbpm.services.api.query.model.QueryDefinition
Returns expression used to collect/fetch data as part of the query
getForms() - Method in interface org.jbpm.services.api.model.ProcessDesc
 
getId() - Method in interface org.jbpm.services.api.model.DeployedAsset
 
getId() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
 
getId() - Method in interface org.jbpm.services.api.model.ProcessDefinition
 
getId() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
 
getIdentifier() - Method in interface org.jbpm.services.api.model.DeploymentUnit
 
getInitiator() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
 
getJavaClasses(String, String) - Method in interface org.jbpm.services.api.DefinitionService
Returns a list of all referenced java classes defined in the given process.
getKnowledgeType() - Method in interface org.jbpm.services.api.model.DeployedAsset
 
getListeners() - Method in interface org.jbpm.services.api.ListenerSupport
 
getMessage() - Method in interface org.jbpm.services.api.admin.MigrationEntry
Returns actual message of the entry
getName() - Method in interface org.jbpm.services.api.model.DeployedAsset
 
getName() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
 
getName() - Method in interface org.jbpm.services.api.model.ProcessDefinition
 
getName() - Method in interface org.jbpm.services.api.model.UserTaskDefinition
 
getName() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
 
getName() - Method in interface org.jbpm.services.api.query.model.QueryDefinition
Return unique name of this query
getName() - Method in class org.jbpm.services.api.query.NamedQueryMapper
 
getName() - Method in interface org.jbpm.services.api.query.QueryResultMapper
Returns unique name of this query result mapper implementation
getNamespace() - Method in interface org.jbpm.services.api.model.ProcessDesc
 
getNewValue() - Method in interface org.jbpm.services.api.model.VariableDesc
 
getNodeId() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
 
getNodeInstanceForWorkItem(Long) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns active node instance descriptor for given work item id, if exists.
getNodeType() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
 
getOldValue() - Method in interface org.jbpm.services.api.model.VariableDesc
 
getOperator() - Method in class org.jbpm.services.api.query.model.QueryParam
 
getOriginalPath() - Method in interface org.jbpm.services.api.model.DeployedAsset
 
getPackageName() - Method in interface org.jbpm.services.api.model.ProcessDefinition
 
getPackageName() - Method in interface org.jbpm.services.api.model.ProcessDesc
 
getParentId() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
 
getPriority() - Method in interface org.jbpm.services.api.model.UserTaskDefinition
 
getPriority() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
 
getProcessById(String) - Method in interface org.jbpm.services.api.RuntimeDataService
Deprecated.
will be removed in version 7
getProcessDefinition(String, String) - Method in interface org.jbpm.services.api.DefinitionService
Returns previously built ProcessDefinition.
getProcesses(QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns all process definitions available
getProcessesByDeploymentId(String, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns list of process definitions for given deployment id
getProcessesByDeploymentIdProcessId(String, String) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns process definition for given deployment and process identifiers
getProcessesByFilter(String, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns list of process definitions that match the given filter
getProcessesById(String) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns process definitions for given process id regardless of the deployment
getProcessId() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
 
getProcessId() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
 
getProcessIds(String, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns list of process definition identifiers for given deployment id
getProcessInstance(Long) - Method in interface org.jbpm.services.api.ProcessService
Returns process instance information.
getProcessInstance(CorrelationKey) - Method in interface org.jbpm.services.api.ProcessService
Returns process instance information.
getProcessInstanceByCorrelationKey(CorrelationKey) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns active process instance description found for given correlation key if found otherwise null.
getProcessInstanceById(long) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns process instance descriptions found for given processInstanceId if found otherwise null.
getProcessInstanceDescription() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
 
getProcessInstanceFullHistory(long, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns complete trace of all executed (completed) and active nodes for given process instance id
getProcessInstanceFullHistoryByType(long, RuntimeDataService.EntryType, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns complete trace of all events of given type (START or END) for given process instance.
getProcessInstanceHistoryActive(long, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns trace of all active nodes for given process instance id
getProcessInstanceHistoryCompleted(long, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns trace of all executed (completed) for given process instance id
getProcessInstanceId() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
 
getProcessInstanceId() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
 
getProcessInstanceId() - Method in interface org.jbpm.services.api.model.VariableDesc
 
getProcessInstances(QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns list of process instance descriptions
getProcessInstances(List<Integer>, String, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns list of process instance descriptions found with given statuses and initiated by initiator.
getProcessInstancesByCorrelationKey(CorrelationKey, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns process instances descriptions (regardless of their states) found for given correlation key if found otherwise empty list.
getProcessInstancesByDeploymentId(String, List<Integer>, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns list of process instance descriptions found for given deployment id and statuses.
getProcessInstancesByProcessDefinition(String, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns list of process instance descriptions found for given process definition id
getProcessInstancesByProcessDefinition(String, List<Integer>, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns list of process instance descriptions found for given process definition id
getProcessInstancesByProcessId(List<Integer>, String, String, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns list of process instance descriptions found for given process id and statuses and initiated by initiator
getProcessInstancesByProcessName(List<Integer>, String, String, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
 
getProcessInstancesByVariable(String, List<Integer>, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns process instance descriptions found for process instance that have defined given variable
getProcessInstancesByVariableAndValue(String, String, List<Integer>, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns process instance descriptions found for process instance that have defined given variable and its value matches given variableValue
getProcessInstanceVariable(Long, String) - Method in interface org.jbpm.services.api.ProcessService
Gets a process instance's variable.
getProcessInstanceVariables(Long) - Method in interface org.jbpm.services.api.ProcessService
Gets a process instance's variable values.
getProcessName() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
 
getProcessVariables(String, String) - Method in interface org.jbpm.services.api.DefinitionService
Returns all process variables defined in the given process where: key in the map is name of the process variable value in the map is type of the process variable
NOTE: This method assumes process has already been built by invoking buildProcessDefinition method
getProcessVariables() - Method in interface org.jbpm.services.api.model.ProcessDefinition
 
getProcessVersion() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
 
getQueries(QueryContext) - Method in interface org.jbpm.services.api.query.QueryService
Returns list of query definitions registered in the system
getQuery(String) - Method in interface org.jbpm.services.api.query.QueryService
Returns query definition details that is registered under given uniqueQueryName
getReusableSubProcesses(String, String) - Method in interface org.jbpm.services.api.DefinitionService
Returns collection of process identifiers of reusable processes used by given process.
getReusableSubProcesses() - Method in interface org.jbpm.services.api.model.ProcessDefinition
 
getRoles() - Method in interface org.jbpm.services.api.model.ProcessDesc
 
getRuleSets(String, String) - Method in interface org.jbpm.services.api.DefinitionService
Returns a list of all referenced rules used in the given process.
getRuntimeManager(String) - Method in interface org.jbpm.services.api.DeploymentService
Returns RuntimeManager instance dedicated to deployment unit identified by given id
getRuntimeManager() - Method in interface org.jbpm.services.api.model.DeployedUnit
 
getServiceTasks(String, String) - Method in interface org.jbpm.services.api.DefinitionService
Returns service (domain specific) tasks defined in the process where: key in the map is name of the task node value in the map is name of the domain specific service (name that handler should be registered with)
NOTE: This method assumes process has already been built by invoking buildProcessDefinition method
getServiceTasks() - Method in interface org.jbpm.services.api.model.ProcessDefinition
 
getSource() - Method in interface org.jbpm.services.api.query.model.QueryDefinition
Returns source location of this query Depends on exact type of the query definition (e.g. data base location - data source name)
getStartDate() - Method in interface org.jbpm.services.api.admin.MigrationReport
Timestamp representing start time of the migration
getState() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
 
getStatus() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
 
getStrategy() - Method in interface org.jbpm.services.api.model.DeploymentUnit
 
getTarget() - Method in interface org.jbpm.services.api.query.model.QueryDefinition
Returns target of this query definition
getTask(Long) - Method in interface org.jbpm.services.api.UserTaskService
Returns task instance
getTaskById(Long) - Method in interface org.jbpm.services.api.RuntimeDataService
Return a task by its taskId.
getTaskByWorkItemId(Long) - Method in interface org.jbpm.services.api.RuntimeDataService
Return a task by its workItemId.
getTaskEvents(long, QueryFilter) - Method in interface org.jbpm.services.api.RuntimeDataService
Gets a list of task events for given task
getTaskId() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
 
getTaskInputContentByTaskId(Long) - Method in interface org.jbpm.services.api.UserTaskService
Returns task input data of a task
getTaskInputMappings(String, String, String) - Method in interface org.jbpm.services.api.DefinitionService
Returns map of data input defined for given user task key in the map is identifier of dataInput value in the map is name dataInput
NOTE: This method assumes process has already been built by invoking buildProcessDefinition method
getTaskInputMappings() - Method in interface org.jbpm.services.api.model.UserTaskDefinition
 
getTaskOutputContentByTaskId(Long) - Method in interface org.jbpm.services.api.UserTaskService
Returns task output data currently stored, might be null of no data is stored
getTaskOutputMappings(String, String, String) - Method in interface org.jbpm.services.api.DefinitionService
Returns map of data output defined for given user task key in the map is identifier of dataOutput value in the map is name dataOutput
NOTE: This method assumes process has already been built by invoking buildProcessDefinition method
getTaskOutputMappings() - Method in interface org.jbpm.services.api.model.UserTaskDefinition
 
getTasksAssignedAsBusinessAdministrator(String, QueryFilter) - Method in interface org.jbpm.services.api.RuntimeDataService
Return a list of assigned tasks as a Business Administrator.
getTasksAssignedAsBusinessAdministratorByStatus(String, List<Status>, QueryFilter) - Method in interface org.jbpm.services.api.RuntimeDataService
Return a list of assigned tasks as a Business Administrator for with one of the listed statuses
getTasksAssignedAsPotentialOwner(String, QueryFilter) - Method in interface org.jbpm.services.api.RuntimeDataService
Return a list of tasks the user is eligible for.
getTasksAssignedAsPotentialOwner(String, List<String>, QueryFilter) - Method in interface org.jbpm.services.api.RuntimeDataService
Return a list of tasks the user or groups are eligible for.
getTasksAssignedAsPotentialOwner(String, List<String>, List<Status>, QueryFilter) - Method in interface org.jbpm.services.api.RuntimeDataService
Return a list of tasks the user or groups are eligible for with one of the listed statuses.
getTasksAssignedAsPotentialOwnerByExpirationDateOptional(String, List<Status>, Date, QueryFilter) - Method in interface org.jbpm.services.api.RuntimeDataService
Return a list of tasks the user is eligible for with one of the listed statuses and expiration date starting at from.
getTasksAssignedAsPotentialOwnerByStatus(String, List<Status>, QueryFilter) - Method in interface org.jbpm.services.api.RuntimeDataService
Return a list of tasks the user is eligible for with one of the listed statuses.
getTasksByProcessInstanceId(Long) - Method in interface org.jbpm.services.api.RuntimeDataService
Get a list of tasks the Process Instance is waiting on.
getTasksByStatusByProcessInstanceId(Long, List<Status>, QueryFilter) - Method in interface org.jbpm.services.api.RuntimeDataService
Get a list of tasks the Process Instance is waiting on with one of the listed statuses.
getTasksByVariable(String, String, List<Status>, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Gets a list of TaskSummary instances for the given arguments
getTasksByVariableAndValue(String, String, String, List<Status>, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Gets a list of TaskSummary instances for the given arguments
getTasksDefinitions(String, String) - Method in interface org.jbpm.services.api.DefinitionService
Returns all user task definitions defined in given process
NOTE: This method assumes process has already been built by invoking buildProcessDefinition method
getTasksOwned(String, QueryFilter) - Method in interface org.jbpm.services.api.RuntimeDataService
Return a list of tasks the user has claimed.
getTasksOwnedByExpirationDateOptional(String, List<Status>, Date, QueryFilter) - Method in interface org.jbpm.services.api.RuntimeDataService
Return a list of tasks the user has claimed with one of the listed statuses and expiration date starting at from.
getTasksOwnedByStatus(String, List<Status>, QueryFilter) - Method in interface org.jbpm.services.api.RuntimeDataService
Return a list of tasks the user has claimed with one of the listed statuses.
getTimestamp() - Method in interface org.jbpm.services.api.admin.MigrationEntry
Return timestamp of the entry - when it was created
getType() - Method in interface org.jbpm.services.api.admin.MigrationEntry
Returns type of the entry - INFO, WARN, ERROR
getType() - Method in interface org.jbpm.services.api.model.ProcessDefinition
 
getType() - Method in class org.jbpm.services.api.query.NamedQueryMapper
 
getType() - Method in interface org.jbpm.services.api.query.QueryResultMapper
Returns type of the data produced by this mapper.
getValue() - Method in class org.jbpm.services.api.query.model.QueryParam
 
getValue() - Method in enum org.jbpm.services.api.RuntimeDataService.EntryType
 
getVariableHistory(long, String, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns collection of changes to given variable within scope of process instance
getVariableId() - Method in interface org.jbpm.services.api.model.VariableDesc
 
getVariableInstanceId() - Method in interface org.jbpm.services.api.model.VariableDesc
 
getVariables() - Method in interface org.jbpm.services.api.model.ProcessInstanceWithVarsDesc
 
getVariables() - Method in interface org.jbpm.services.api.model.UserTaskInstanceWithVarsDesc
 
getVariablesCurrentState(long) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns collections of all process variables current value for given process instance
getVersion() - Method in interface org.jbpm.services.api.model.DeployedAsset
 
getVersion() - Method in interface org.jbpm.services.api.model.ProcessDefinition
 
getWorkItem(Long) - Method in interface org.jbpm.services.api.ProcessService
Returns the specified workItem
getWorkItemByProcessInstance(Long) - Method in interface org.jbpm.services.api.ProcessService
Returns active work items by process instance id.
getWorkItemId() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
 
greaterOrEqualTo(String, Comparable<?>) - Static method in class org.jbpm.services.api.query.model.QueryParam
 
greaterThan(String, Comparable<?>) - Static method in class org.jbpm.services.api.query.model.QueryParam
 

I

in(String, List<?>) - Static method in class org.jbpm.services.api.query.model.QueryParam
 
isActive() - Method in interface org.jbpm.services.api.model.DeployedUnit
 
isCompleted() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
 
isDeployed(String) - Method in interface org.jbpm.services.api.DeploymentService
Performs a check if given deployment is already active
isNotNull(String) - Static method in class org.jbpm.services.api.query.model.QueryParam
 
isNull(String) - Static method in class org.jbpm.services.api.query.model.QueryParam
 
isSkippable() - Method in interface org.jbpm.services.api.model.UserTaskDefinition
 
isSuccessful() - Method in interface org.jbpm.services.api.admin.MigrationReport
Indicates if the migration was successful or not

L

likeTo(String, boolean, Comparable<?>) - Static method in class org.jbpm.services.api.query.model.QueryParam
 
ListenerSupport - Interface in org.jbpm.services.api
 
logger - Static variable in class org.jbpm.services.api.query.QueryMapperRegistry
 
lowerOrEqualTo(String, Comparable<?>) - Static method in class org.jbpm.services.api.query.model.QueryParam
 
lowerThan(String, Comparable<?>) - Static method in class org.jbpm.services.api.query.model.QueryParam
 

M

map(Object) - Method in class org.jbpm.services.api.query.NamedQueryMapper
 
map(Object) - Method in interface org.jbpm.services.api.query.QueryResultMapper
Based on raw data set returns mapped/transformed data.
mapperFor(String, Map<String, String>) - Method in class org.jbpm.services.api.query.QueryMapperRegistry
Returns mapper for given name if found
migrate(String, Long, String, String) - Method in interface org.jbpm.services.api.admin.ProcessInstanceMigrationService
Migrates given process instance that belongs to source deployment, into target process id that belongs to target deployment.
migrate(String, Long, String, String, Map<String, String>) - Method in interface org.jbpm.services.api.admin.ProcessInstanceMigrationService
Migrates given process instance (with node mapping) that belongs to source deployment, into target process id that belongs to target deployment.
migrate(String, List<Long>, String, String) - Method in interface org.jbpm.services.api.admin.ProcessInstanceMigrationService
Migrates given process instances that belong to source deployment, into target process id that belongs to target deployment.
migrate(String, List<Long>, String, String, Map<String, String>) - Method in interface org.jbpm.services.api.admin.ProcessInstanceMigrationService
Migrates given process instances (with node mapping) that belong to source deployment, into target process id that belongs to target deployment.
MigrationEntry - Interface in org.jbpm.services.api.admin
Single migration step information that comes with message, timestamp and type (INFO, WARN, ERROR)
MigrationReport - Interface in org.jbpm.services.api.admin
Represents complete migration report to provide all required details about performed steps during process instance migration.

N

NamedQueryMapper<T> - Class in org.jbpm.services.api.query
A delegate mapper that will delay look up of actual mapper to the time its map method is invoked.
NamedQueryMapper(String) - Constructor for class org.jbpm.services.api.query.NamedQueryMapper
Creates new instance with actual mapper name
newInstance(Map<String, Object>) - Method in interface org.jbpm.services.api.query.QueryParamBuilderFactory
Returns new QueryParamBuilder instance constructed with given parameters
NodeInstanceDesc - Interface in org.jbpm.services.api.model
 
nominate(Long, String, List<OrganizationalEntity>) - Method in interface org.jbpm.services.api.UserTaskService
Nominate a task to be handled by potentialOwners
notEqualsTo(String, Comparable<?>...) - Static method in class org.jbpm.services.api.query.model.QueryParam
 
notIn(String, List<?>) - Static method in class org.jbpm.services.api.query.model.QueryParam
 

O

onActivate(DeploymentEvent) - Method in interface org.jbpm.services.api.DeploymentEventListener
 
onDeactivate(DeploymentEvent) - Method in interface org.jbpm.services.api.DeploymentEventListener
 
onDeploy(DeploymentEvent) - Method in interface org.jbpm.services.api.DeploymentEventListener
 
onUnDeploy(DeploymentEvent) - Method in interface org.jbpm.services.api.DeploymentEventListener
 
org.jbpm.services.api - package org.jbpm.services.api
 
org.jbpm.services.api.admin - package org.jbpm.services.api.admin
 
org.jbpm.services.api.model - package org.jbpm.services.api.model
 
org.jbpm.services.api.query - package org.jbpm.services.api.query
 
org.jbpm.services.api.query.model - package org.jbpm.services.api.query.model
 

P

ProcessDefinition - Interface in org.jbpm.services.api.model
 
ProcessDesc - Interface in org.jbpm.services.api.model
 
ProcessInstanceDesc - Interface in org.jbpm.services.api.model
 
ProcessInstanceMigrationService - Interface in org.jbpm.services.api.admin
Provides migration service for process instances.
ProcessInstanceNotFoundException - Exception in org.jbpm.services.api
 
ProcessInstanceNotFoundException(String) - Constructor for exception org.jbpm.services.api.ProcessInstanceNotFoundException
 
ProcessInstanceNotFoundException(String, Throwable) - Constructor for exception org.jbpm.services.api.ProcessInstanceNotFoundException
 
ProcessInstanceWithVarsDesc - Interface in org.jbpm.services.api.model
 
ProcessService - Interface in org.jbpm.services.api
 

Q

query(String, QueryResultMapper<T>, QueryContext, QueryParam...) - Method in interface org.jbpm.services.api.query.QueryService
Performs query on given query definition that had to be previously registered.
query(String, QueryResultMapper<T>, QueryContext, QueryParamBuilder<?>) - Method in interface org.jbpm.services.api.query.QueryService
Performs query on given query definition that had to be previously registered.
QueryAlreadyRegisteredException - Exception in org.jbpm.services.api.query
 
QueryAlreadyRegisteredException(String) - Constructor for exception org.jbpm.services.api.query.QueryAlreadyRegisteredException
 
QueryAlreadyRegisteredException(String, Throwable) - Constructor for exception org.jbpm.services.api.query.QueryAlreadyRegisteredException
 
QueryDefinition - Interface in org.jbpm.services.api.query.model
Definition of a query that can be registered in the query service
QueryDefinition.Target - Enum in org.jbpm.services.api.query.model
 
QueryMapperRegistry - Class in org.jbpm.services.api.query
Allow to find mappers by name instead of using their instances Mappers are discovered by ServiceLoader mechanism - meaning must be defined in services file:
META-INF/services/org.jbpm.services.api.query.QueryResultMapper
as fully qualified class names that implement org.jbpm.services.api.query.QueryResultMapper
QueryMapperRegistry() - Constructor for class org.jbpm.services.api.query.QueryMapperRegistry
 
QueryNotFoundException - Exception in org.jbpm.services.api.query
 
QueryNotFoundException(String) - Constructor for exception org.jbpm.services.api.query.QueryNotFoundException
 
QueryNotFoundException(String, Throwable) - Constructor for exception org.jbpm.services.api.query.QueryNotFoundException
 
QueryParam - Class in org.jbpm.services.api.query.model
Basic data carrier to provide filtering capabilities on top of query definition.
QueryParam(String, String, List<?>) - Constructor for class org.jbpm.services.api.query.model.QueryParam
 
QueryParamBuilder<T> - Interface in org.jbpm.services.api.query
QueryParamBuilder is responsible for building up one or more filter parameters.
QueryParamBuilderFactory - Interface in org.jbpm.services.api.query
Factory for query param builders that can be constructed based on: identifier set of parameters - key value pairs
QueryResultMapper<T> - Interface in org.jbpm.services.api.query
Maps raw data set into object instances
QueryService - Interface in org.jbpm.services.api.query
Advanced queries service that allows to register custom queries that will be equipped with tailored capabilities of querying data.

R

registerQuery(QueryDefinition) - Method in interface org.jbpm.services.api.query.QueryService
Registers new query definition in the system so it can be used for executing queries on top of it.
release(Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Release a previously claimed task
removeListener(DeploymentEventListener) - Method in interface org.jbpm.services.api.ListenerSupport
 
removeMapper(String) - Method in class org.jbpm.services.api.query.QueryMapperRegistry
 
replaceQuery(QueryDefinition) - Method in interface org.jbpm.services.api.query.QueryService
Registers or replaces existing query.
resume(Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Resume a previously suspended task
RuntimeDataService - Interface in org.jbpm.services.api
This service provides an interface to retrieve data about the runtime, including the following: process instances process definitions node instance information variable information
RuntimeDataService.EntryType - Enum in org.jbpm.services.api
Represents type of node instance log entries.

S

saveContent(Long, Map<String, Object>) - Method in interface org.jbpm.services.api.UserTaskService
Saves gives values as content of a task, applies to task output as input cannot be altered
setColumn(String) - Method in class org.jbpm.services.api.query.model.QueryParam
 
setDeployedUnit(DeployedUnit) - Method in class org.jbpm.services.api.DeploymentEvent
 
setDeploymentId(String) - Method in class org.jbpm.services.api.DeploymentEvent
 
setDescription(Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Sets description of the task
setExpirationDate(Long, Date) - Method in interface org.jbpm.services.api.UserTaskService
Sets expiration date of a task to given value
setExpression(String) - Method in interface org.jbpm.services.api.query.model.QueryDefinition
Sets expression used to collect/fetch data as part of the query
setName(String) - Method in interface org.jbpm.services.api.query.model.QueryDefinition
Sets unique name for this query definition
setName(Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Sets name of the task
setOperator(String) - Method in class org.jbpm.services.api.query.model.QueryParam
 
setPriority(Long, int) - Method in interface org.jbpm.services.api.UserTaskService
Sets priority of a task to given value
setProcessVariable(Long, String, Object) - Method in interface org.jbpm.services.api.ProcessService
Sets a process variable.
setProcessVariables(Long, Map<String, Object>) - Method in interface org.jbpm.services.api.ProcessService
Sets process variables.
setSkipable(Long, boolean) - Method in interface org.jbpm.services.api.UserTaskService
Sets skipable property of a task to given value
setSource(String) - Method in interface org.jbpm.services.api.query.model.QueryDefinition
Sets source location of this query Depends on exact type of the query definition (e.g. data base location - data source name)
setValue(List<?>) - Method in class org.jbpm.services.api.query.model.QueryParam
 
signalEvent(String, String, Object) - Method in interface org.jbpm.services.api.ProcessService
Signal an event to a any process instance that listens to give signal that belongs to given deployment
signalProcessInstance(Long, String, Object) - Method in interface org.jbpm.services.api.ProcessService
Signal an event to a single process instance
signalProcessInstances(List<Long>, String, Object) - Method in interface org.jbpm.services.api.ProcessService
Signal an event to given list of process instances
skip(Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Skip a claimed task
start(Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Start the execution of the task, i.e. set the task to status InProgress.
startProcess(String, String, CorrelationKey, Map<String, Object>, Long) - Method in interface org.jbpm.services.api.AdHocProcessService
Starts a process with a map of variables
startProcess(String, String) - Method in interface org.jbpm.services.api.ProcessService
Starts a process with no variables
startProcess(String, String, Map<String, Object>) - Method in interface org.jbpm.services.api.ProcessService
Starts a process with no variables
startProcess(String, String, CorrelationKey) - Method in interface org.jbpm.services.api.ProcessService
Starts a process with no variables
startProcess(String, String, CorrelationKey, Map<String, Object>) - Method in interface org.jbpm.services.api.ProcessService
Starts a process with no variables
stop(Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Cancel/stop the processing of the task.
suspend(Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Suspend a claimed task.

T

TaskNotFoundException - Exception in org.jbpm.services.api
 
TaskNotFoundException(String) - Constructor for exception org.jbpm.services.api.TaskNotFoundException
 
TaskNotFoundException(String, Throwable) - Constructor for exception org.jbpm.services.api.TaskNotFoundException
 
taskSummaryQuery(String) - Method in interface org.jbpm.services.api.RuntimeDataService
Query on TaskSummary instaances.

U

undeploy(DeploymentUnit) - Method in interface org.jbpm.services.api.DeploymentService
Performs undeployment operation of given unit.
unregisterQuery(String) - Method in interface org.jbpm.services.api.query.QueryService
Removes the query definition from the system
updateTask(long, int, String, Date) - Method in interface org.jbpm.services.api.AdHocUserTaskService
 
UserTaskDefinition - Interface in org.jbpm.services.api.model
 
UserTaskInstanceDesc - Interface in org.jbpm.services.api.model
 
UserTaskInstanceWithVarsDesc - Interface in org.jbpm.services.api.model
 
UserTaskService - Interface in org.jbpm.services.api
 

V

valueOf(String) - Static method in enum org.jbpm.services.api.query.model.QueryDefinition.Target
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jbpm.services.api.RuntimeDataService.EntryType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jbpm.services.api.query.model.QueryDefinition.Target
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jbpm.services.api.RuntimeDataService.EntryType
Returns an array containing the constants of this enum type, in the order they are declared.
VariableDesc - Interface in org.jbpm.services.api.model
 

W

WorkItemNotFoundException - Exception in org.jbpm.services.api
 
WorkItemNotFoundException(String) - Constructor for exception org.jbpm.services.api.WorkItemNotFoundException
 
WorkItemNotFoundException(String, Throwable) - Constructor for exception org.jbpm.services.api.WorkItemNotFoundException
 
A B C D E F G I L M N O P Q R S T U V W 
Skip navigation links
jBPM :: Services API 6.5.0.Final-redhat-23

Copyright © 2001–2018 JBoss by Red Hat. All rights reserved.