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

A

abortProcessInstance(Long) - Method in interface org.jbpm.services.api.ProcessService
Aborts the specified process
abortProcessInstance(String, 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
abortProcessInstances(String, 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
abortWorkItem(String, Long, 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
acknowledgeError(String...) - Method in interface org.jbpm.services.api.admin.ProcessInstanceAdminService
Acknowledge given error that it was reviewed and understood
acknowledgeError(String...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Acknowledge given error that it was reviewed and understood
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.
activate(String, 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
addAttachment(String, Long, String, String, Object) - Method in interface org.jbpm.services.api.UserTaskService
Add attachment to a task
addBusinessAdmins(long, boolean, OrganizationalEntity...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Adds new business admin for a given task.
addBusinessAdmins(String, long, boolean, OrganizationalEntity...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Adds new business admin for a given task.
addComment(Long, String, String, Date) - Method in interface org.jbpm.services.api.UserTaskService
Add comment to a task
addComment(String, Long, String, String, Date) - Method in interface org.jbpm.services.api.UserTaskService
Add comment to a task
addExcludedOwners(long, boolean, OrganizationalEntity...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Adds new excluded owners for a given task.
addExcludedOwners(String, long, boolean, OrganizationalEntity...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Adds new excluded owners for a given task.
addListener(DeploymentEventListener) - Method in interface org.jbpm.services.api.ListenerSupport
Adds a new deployment listener.
addMapper(QueryResultMapper<?>) - Method in class org.jbpm.services.api.query.QueryMapperRegistry
Adds a new query results mapper
addPotentialOwners(long, boolean, OrganizationalEntity...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Adds new potential owners for a given task.
addPotentialOwners(String, long, boolean, OrganizationalEntity...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Adds new potential owners for a given task.
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
Adds a new ad-hoc task.
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
Adds a new ad-hoc task.
addTaskInput(long, String, Object) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Adds new item to task input variables.
addTaskInput(String, long, String, Object) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Adds new item to task input variables.
addTaskInputs(long, Map<String, Object>) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Adds new items to task input variables.
addTaskInputs(String, long, Map<String, Object>) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Adds new items to task input variables.
AdHocProcessService - Interface in org.jbpm.services.api
Service for starting ad-hoc processes.
AdHocUserTaskService - Interface in org.jbpm.services.api
Service for adding and updating ad-hoc user tasks.
AdvanceRuntimeDataService - Interface in org.jbpm.services.api
 
append(QueryParam...) - Method in class org.jbpm.services.api.query.model.QueryParam.Builder
Appends new query parameters to existing ones.
average(String) - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns the "average" query parameter for given column.

B

between(String, Comparable<?>, Comparable<?>) - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns the "between" query parameter for given column, start and end.
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.
buildEmailNotification(String, List<OrganizationalEntity>, String, String, String) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Builds email notification based on given parameters that can be used as argument for notifyWhenNotStarted and notifyWhenNotCompleted methods
Builder() - Constructor for class org.jbpm.services.api.query.model.QueryParam.Builder
 
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

cancelNodeInstance(long, long) - Method in interface org.jbpm.services.api.admin.ProcessInstanceAdminService
Cancels node instance with given id within given process instance.
cancelNotification(long, long) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Cancels given notification on a task
cancelNotification(String, long, long) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Cancels given notification on a task
cancelReassignment(long, long) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Cancels given reassignment on a task
cancelReassignment(String, long, long) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Cancels given reassignment on a task
CASE_RUNTIME_DATA_SERVICE - Static variable in class org.jbpm.services.api.service.ServiceRegistry
 
CASE_SERVICE - Static variable in class org.jbpm.services.api.service.ServiceRegistry
 
CENTURY - Static variable in class org.jbpm.services.api.query.model.QueryParam
 
claim(Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Claim responsibility for a task, i.e. set the task to status Reserved
claim(String, Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Claim responsibility for a task, i.e. set the task to status Reserved
clear() - Method in class org.jbpm.services.api.service.ServiceRegistry
Removes all services from the registry
close() - Method in interface org.jbpm.services.api.utils.KieServiceConfigurator
Closes the configurator.
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_ERROR - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_ERROR_ACK - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_ERROR_ACK_AT - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_ERROR_ACK_BY - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_ERROR_ACTIVITY_ID - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_ERROR_ACTIVITY_NAME - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_ERROR_DATE - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_ERROR_DEPLOYMENT_ID - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_ERROR_ID - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_ERROR_JOB_ID - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_ERROR_MSG - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_ERROR_PROCESS_ID - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_ERROR_PROCESS_INST_ID - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_ERROR_TYPE - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_EXCLUDED_OWNER - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_EXPIRATIONTIME - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_EXTERNALID - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_FORM_NAME - 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_LASTMODIFICATION_DATE - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_LASTMODIFICATION_USER - 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_POTOWNER - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_PRIORITY - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_PROCESS_LASTMODIFICATIONDATE - 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_SLA_COMPLIANCE - Static variable in interface org.jbpm.services.api.query.QueryResultMapper
 
COLUMN_SLA_DUE_DATE - 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_TYPE - 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
complete(String, 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.
completeAutoProgress(String, 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
completeWorkItem(String, Long, Long, Map<String, Object>) - Method in interface org.jbpm.services.api.ProcessService
Completes the specified WorkItem with the given results
configureServices(String, IdentityProvider, UserGroupCallback) - Method in interface org.jbpm.services.api.utils.KieServiceConfigurator
Configures a new kie service.
count(String) - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns the "count" query parameter for given column.
createDeploymentUnit(String, String, String) - Method in interface org.jbpm.services.api.utils.KieServiceConfigurator
Created a new deployment unit

D

DAY - Static variable in class org.jbpm.services.api.query.model.QueryParam
 
DAY_OF_WEEK - Static variable in class org.jbpm.services.api.query.model.QueryParam
 
deactivate(String) - Method in interface org.jbpm.services.api.DeploymentService
Deactivates given deployment by making it only available for already running instances.
DECADE - Static variable in class org.jbpm.services.api.query.model.QueryParam
 
DEFINITION_SERVICE - Static variable in class org.jbpm.services.api.service.ServiceRegistry
 
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
delegate(String, 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
deleteAttachment(String, 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
deleteComment(String, 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
deleteContent(String, 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
 
DEPLOYMENT_SERVICE - Static variable in class org.jbpm.services.api.service.ServiceRegistry
 
DeploymentEvent - Class in org.jbpm.services.api
Event containing information about a deployment.
DeploymentEvent(String, DeployedUnit) - Constructor for class org.jbpm.services.api.DeploymentEvent
Create a new deployment event given deployment id and deployed unit.
DeploymentEventListener - Interface in org.jbpm.services.api
 
DeploymentNotActiveException - Exception in org.jbpm.services.api
 
DeploymentNotActiveException(String) - Constructor for exception org.jbpm.services.api.DeploymentNotActiveException
 
DeploymentNotActiveException(String, Throwable) - Constructor for exception org.jbpm.services.api.DeploymentNotActiveException
 
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.
distinct(String) - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns the "distinct" query parameter for given column.

E

equalsTo(String, Comparable<?>...) - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns "equal" query parameter for given column and set of values.
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
ExecutionErrorNotFoundException - Exception in org.jbpm.services.api.admin
 
ExecutionErrorNotFoundException(String) - Constructor for exception org.jbpm.services.api.admin.ExecutionErrorNotFoundException
 
ExecutionErrorNotFoundException(String, Throwable) - Constructor for exception org.jbpm.services.api.admin.ExecutionErrorNotFoundException
 
EXECUTOR_SERVICE - Static variable in class org.jbpm.services.api.service.ServiceRegistry
 
exit(Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Requesting application is no longer interested in the task output
exit(String, 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.
fail(String, 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.
forward(String, Long, String, String) - Method in interface org.jbpm.services.api.UserTaskService
Forward the task to another organization entity.

G

get() - Method in class org.jbpm.services.api.query.model.QueryParam.Builder
Returns query parameters.
get() - Static method in class org.jbpm.services.api.query.QueryMapperRegistry
Returns instance of the registry that is already populated with known mappers.
get() - Static method in class org.jbpm.services.api.service.ServiceRegistry
Returns single instance of the registry used to register and retrieve services.
getActivationTime() - Method in interface org.jbpm.services.api.admin.TimerInstance
Returns date when the timer was activated/created
getActivationTime() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Returns the user task instance activation time.
getActiveNodeInstances(long) - Method in interface org.jbpm.services.api.admin.ProcessInstanceAdminService
Returns all active node instances in given process instance;
getActiveTasks() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
Returns the process instance description active tasks.
getActualOwner() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Returns the user task actual owner.
getAdvanceVariableDataService() - Method in interface org.jbpm.services.api.utils.KieServiceConfigurator
Return related data regarding variables (case, process, task)
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
Returns process definition assoaciated entries.
getAssociatedEntities() - Method in interface org.jbpm.services.api.model.UserTaskDefinition
Returns the user task definition associated entities.
getAttachmentById(Long, Long) - Method in interface org.jbpm.services.api.UserTaskService
Get attachment by identifier
getAttachmentById(String, 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
getAttachmentContentById(String, 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
getAttachmentsByTaskId(String, 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
getAvailableSignals(String, Long) - Method in interface org.jbpm.services.api.ProcessService
Returns all signals available in current state of given process instance
getBpmn2Service() - Method in interface org.jbpm.services.api.utils.KieServiceConfigurator
Returns the definition service.
getBuilder() - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns the builder.
getBusinessAdministrators() - Method in interface org.jbpm.services.api.admin.TaskNotification
Returns list of business admins that notification will be sent to
getColumn() - Method in class org.jbpm.services.api.query.model.QueryParam
Returns the column.
getColumns() - Method in interface org.jbpm.services.api.query.model.QueryDefinition
Returns resolved columns types once the query was successfully registered.
getComment() - Method in interface org.jbpm.services.api.model.UserTaskDefinition
Returns the user task definition comment.
getCommentById(Long, Long) - Method in interface org.jbpm.services.api.UserTaskService
Get comment by identifier
getCommentById(String, 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
getCommentsByTaskId(String, Long) - Method in interface org.jbpm.services.api.UserTaskService
Get comments for a task
getConnection() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
Returns the node instance connection.
getContent() - Method in interface org.jbpm.services.api.admin.TaskNotification
Returns the content for this notification
getCorrelationKey() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
Returns the process instance description correlation key.
getCorrelationKey() - Method in interface org.jbpm.services.api.model.UserTaskInstanceWithPotOwnerDesc
Returns the user task correlation key
getCreatedBy() - Method in interface org.jbpm.services.api.model.UserTaskDefinition
Returns the user task created by.
getCreatedBy() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Returns the user task instance created by.
getCreatedOn() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Returns the user task instance created on date.
getDataTimeStamp() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
Returns the node instance timestamp.
getDataTimeStamp() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
Returns the process instance description timestamp.
getDataTimeStamp() - Method in interface org.jbpm.services.api.model.VariableDesc
Returns the variable data timestamp.
getDate() - Method in interface org.jbpm.services.api.admin.TaskNotification
Returns date that the notification is schedule to happen
getDate() - Method in interface org.jbpm.services.api.admin.TaskReassignment
Returns date that the reassignment is schedule to happen
getDelay() - Method in interface org.jbpm.services.api.admin.TimerInstance
Returns delay that comes from definition
getDeployedAssetLocation(String) - Method in interface org.jbpm.services.api.model.DeployedUnit
Returns the deployed asset location.
getDeployedAssets() - Method in interface org.jbpm.services.api.model.DeployedUnit
Returns the deployed assets.
getDeployedClasses() - Method in interface org.jbpm.services.api.model.DeployedUnit
Returns the deployed classes.
getDeployedUnit() - Method in class org.jbpm.services.api.DeploymentEvent
Returns the deployed unit
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
Returns the deployment id.
getDeploymentId() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
Returns the node instance deployment id.
getDeploymentId() - Method in interface org.jbpm.services.api.model.ProcessDefinition
Return the process definition deployment id.
getDeploymentId() - Method in interface org.jbpm.services.api.model.ProcessDesc
Return the process description deployment id.
getDeploymentId() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
Returns the process instance description deployment id.
getDeploymentId() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Returns the user task deployment id.
getDeploymentId() - Method in interface org.jbpm.services.api.model.VariableDesc
Returns the deployment id.
getDeploymentService() - Method in interface org.jbpm.services.api.utils.KieServiceConfigurator
Returns the deployment service.
getDeploymentUnit() - Method in interface org.jbpm.services.api.model.DeployedUnit
Returns the deployed unit.
getDescription() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Returns the user task instance description.
getDueDate() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Returns the user task instance due date.
getEncodedProcessSource() - Method in interface org.jbpm.services.api.model.ProcessDesc
Return the encoded process source.
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
getError(String) - Method in interface org.jbpm.services.api.admin.ProcessInstanceAdminService
Returns execution error identified by given error id
getError(String) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Returns execution error identified by given error id
getErrors(boolean, QueryContext) - Method in interface org.jbpm.services.api.admin.ProcessInstanceAdminService
Returns all execution errors regardless of their type
getErrors(boolean, QueryContext) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Returns execution errors that are classified as task type errors
getErrorsByDeploymentId(String, boolean, QueryContext) - Method in interface org.jbpm.services.api.admin.ProcessInstanceAdminService
Returns all execution errors for a given deployment regardless of their type
getErrorsByProcessId(String, String, boolean, QueryContext) - Method in interface org.jbpm.services.api.admin.ProcessInstanceAdminService
Returns execution errors for given process id and deployment id
getErrorsByProcessInstanceId(long, boolean, QueryContext) - Method in interface org.jbpm.services.api.admin.ProcessInstanceAdminService
Returns execution errors for given process instance id
getErrorsByProcessInstanceId(long, String, boolean, QueryContext) - Method in interface org.jbpm.services.api.admin.ProcessInstanceAdminService
Returns execution errors for given process instance id and node
getErrorsByTaskId(long, boolean, QueryContext) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Returns execution errors for given task id
getErrorsByTaskName(String, boolean, QueryContext) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Returns execution errors for given task name
getErrorsByTaskName(String, String, boolean, QueryContext) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Returns execution errors for given task name and process id
getErrorsByTaskName(String, String, String, boolean, QueryContext) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Returns execution errors for given task name, process id and deployment id
getExpression() - Method in interface org.jbpm.services.api.query.model.QueryDefinition
Returns expression used to collect/fetch data as part of the query.
getExtraData() - Method in interface org.jbpm.services.api.model.ProcessInstanceWithVarsDesc
 
getExtraData() - Method in interface org.jbpm.services.api.model.UserTaskInstanceWithPotOwnerDesc
return the user task process extra data from query
getFormName() - Method in interface org.jbpm.services.api.model.UserTaskDefinition
Returns the user task definition form name.
getFormName() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Returns the user task form name.
getForms() - Method in interface org.jbpm.services.api.model.ProcessDesc
Return the process description forms.
getGlobals() - Method in interface org.jbpm.services.api.model.ProcessDefinition
Returns process definition globals.
getId() - Method in interface org.jbpm.services.api.admin.TaskNotification
Returns unique id of the task notification
getId() - Method in interface org.jbpm.services.api.admin.TaskReassignment
Returns unique id of the task reassignment
getId() - Method in interface org.jbpm.services.api.admin.TimerInstance
Returns id of the timer
getId() - Method in interface org.jbpm.services.api.model.DeployedAsset
Returns the deployed asset id.
getId() - Method in interface org.jbpm.services.api.model.NodeDesc
Returns the node description id.
getId() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
Returns the node instance id.
getId() - Method in interface org.jbpm.services.api.model.ProcessDefinition
Return the process definition id.
getId() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
Returns the process instance description id.
getId() - Method in interface org.jbpm.services.api.model.TimerDesc
Returns the timer description id.
getId() - Method in interface org.jbpm.services.api.model.UserTaskDefinition
Returns the user task definition id.
getIdentifier() - Method in interface org.jbpm.services.api.model.DeploymentUnit
Returns the deployment unit identifier.
getIdentityProvider() - Method in interface org.jbpm.services.api.utils.KieServiceConfigurator
Returns the identity provider.
getInitiator() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
Returns the process instance description initiator.
getInputdata() - Method in interface org.jbpm.services.api.model.UserTaskInstanceWithPotOwnerDesc
Returns the user task input data
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
Returns the deployed asset knowledge type.
getLastFireTime() - Method in interface org.jbpm.services.api.admin.TimerInstance
Returns date when the timer was fired last time, can be null
getLastModificationDate() - Method in interface org.jbpm.services.api.model.ProcessInstanceCustomDesc
Returns the process instance custom description last modification date.
getLastModificationDate() - Method in interface org.jbpm.services.api.model.UserTaskInstanceWithPotOwnerDesc
Returns the user task potential modification date
getLastModificationUser() - Method in interface org.jbpm.services.api.model.UserTaskInstanceWithPotOwnerDesc
Returns the user task last modification user
getListeners() - Method in interface org.jbpm.services.api.ListenerSupport
Returns all deployment listeners
getMessage() - Method in interface org.jbpm.services.api.admin.MigrationEntry
Returns actual message of the entry
getName() - Method in interface org.jbpm.services.api.admin.TaskNotification
Returns optional name of the notification
getName() - Method in interface org.jbpm.services.api.admin.TaskReassignment
Returns optional name of the reassignment
getName() - Method in interface org.jbpm.services.api.model.DeployedAsset
Returns the deployed asset name.
getName() - Method in interface org.jbpm.services.api.model.NodeDesc
Returns the node description name.
getName() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
Returns the node instance name.
getName() - Method in interface org.jbpm.services.api.model.ProcessDefinition
Return the process definition name.
getName() - Method in interface org.jbpm.services.api.model.UserTaskDefinition
Returns the user task definition name.
getName() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Returns the user task instance name.
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
Return the process description namespace.
getNewValue() - Method in interface org.jbpm.services.api.model.VariableDesc
Returns the variable new value.
getNextFireTime() - Method in interface org.jbpm.services.api.admin.TimerInstance
Returns next date when the timer is expected to fire
getNodeContainerId() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
Returns the node instance container id.
getNodeId() - Method in interface org.jbpm.services.api.admin.ProcessNode
Returns unique id of the node
getNodeId() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
Returns the node instance node id.
getNodeId() - Method in interface org.jbpm.services.api.model.TimerDesc
Returns the timer description node id.
getNodeInstanceForWorkItem(Long) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns active node instance descriptor for given work item id, if exists.
getNodeInstancesByCorrelationKeyNodeType(CorrelationKey, List<Integer>, List<String>, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns trace of all nodes for a given node types and correlation key
getNodeInstancesByNodeType(long, List<String>, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns trace of all nodes for a given node types and process instance id
getNodeName() - Method in interface org.jbpm.services.api.admin.ProcessNode
Returns name of the node
getNodeName() - Method in interface org.jbpm.services.api.model.TimerDesc
Returns the timer description node name.
getNodes() - Method in interface org.jbpm.services.api.model.ProcessDefinition
Returns process definition nodes.
getNodeType() - Method in interface org.jbpm.services.api.admin.ProcessNode
Returns type of the node
getNodeType() - Method in interface org.jbpm.services.api.model.NodeDesc
Returns the node description node type.
getNodeType() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
Returns the node instance node type.
getObjectValue() - Method in class org.jbpm.services.api.query.model.QueryParam
 
getOldValue() - Method in interface org.jbpm.services.api.model.VariableDesc
Returns the variable old value.
getOperator() - Method in class org.jbpm.services.api.query.model.QueryParam
Returns the operator.
getOriginalPath() - Method in interface org.jbpm.services.api.model.DeployedAsset
Returns the deployed asset original path.
getOutputdata() - Method in interface org.jbpm.services.api.model.UserTaskInstanceWithPotOwnerDesc
Returns the user task output data
getPackageName() - Method in interface org.jbpm.services.api.model.ProcessDefinition
Return the process definition package name.
getPackageName() - Method in interface org.jbpm.services.api.model.ProcessDesc
Return the process description package name.
getParentId() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
Returns the process instance description parent id.
getPeriod() - Method in interface org.jbpm.services.api.admin.TimerInstance
Returns period that comes from definition - only for repeatable timers
getPotentialOwners() - Method in interface org.jbpm.services.api.admin.TaskReassignment
Returns list of potential owners to be set after reassignment
getPotentialOwners() - Method in interface org.jbpm.services.api.model.UserTaskInstanceWithPotOwnerDesc
Returns the user task potential owners
getPriority() - Method in interface org.jbpm.services.api.model.UserTaskDefinition
Returns the user task definition priority.
getPriority() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Returns the user task instance priority.
getProcessAdminService() - Method in interface org.jbpm.services.api.utils.KieServiceConfigurator
Returns the process instance admin service
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.admin.ProcessNode
Returns process id node belongs to
getProcessId() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
Returns the process instance description process id.
getProcessId() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Returns the user task process id.
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(String, 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.
getProcessInstance(String, 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
Returns the process instance description.
getProcessInstanceDescription() - Method in interface org.jbpm.services.api.model.UserTaskInstanceWithPotOwnerDesc
Returns the user task process instance description
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, END, ABORTED, SKIPPED, OBSOLETE or ERROR) 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.admin.MigrationReport
Returns process instance id that was migrated
getProcessInstanceId() - Method in interface org.jbpm.services.api.admin.TimerInstance
Returns process instance id that timer belongs to
getProcessInstanceId() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
Returns the process instance id.
getProcessInstanceId() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Returns the user task instance process instance id.
getProcessInstanceId() - Method in interface org.jbpm.services.api.model.VariableDesc
Returns the process instance id.
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.
getProcessInstancesByCorrelationKeyAndStatus(CorrelationKey, List<Integer>, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns process instances descriptions filtered by 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.
getProcessInstancesByParent(Long, List<Integer>, QueryContext) - Method in interface org.jbpm.services.api.RuntimeDataService
Returns list of process instance descriptions
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.
getProcessInstanceVariable(String, 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.
getProcessInstanceVariables(String, 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
Returns the process instance description process name.
getProcessNodes(long) - Method in interface org.jbpm.services.api.admin.ProcessInstanceAdminService
Returns all process nodes found in given process instance.
getProcessService() - Method in interface org.jbpm.services.api.utils.KieServiceConfigurator
Returns the process service.
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
Returns process definition process variables.
getProcessVariables() - Method in interface org.jbpm.services.api.model.UserTaskInstanceWithPotOwnerDesc
Returns the process variables this task belongs
getProcessVersion() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
Returns the process instance description process version.
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
getQueryService() - Method in interface org.jbpm.services.api.utils.KieServiceConfigurator
Returns the query service
getRecipients() - Method in interface org.jbpm.services.api.admin.TaskNotification
Returns list of recipients that notification will be sent to
getReferencedRules() - Method in interface org.jbpm.services.api.model.ProcessDefinition
Returns process definition referenced rules.
getReferenceId() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
Returns the node instance reference id.
getRepeatLimit() - Method in interface org.jbpm.services.api.admin.TimerInstance
Returns repeat limit that comes from definition - only for repeatable timers
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
Returns process definition reusable subprocesses.
getRoles() - Method in interface org.jbpm.services.api.model.ProcessDesc
Return the process description roles.
getRuleSets(String, String) - Method in interface org.jbpm.services.api.DefinitionService
Returns a list of all referenced rules used in the given process.
getRuntimeDataService() - Method in interface org.jbpm.services.api.utils.KieServiceConfigurator
Returns the runtime data service.
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
Returns the runtime manager.
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
Returns process definition service tasks
getSessionId() - Method in interface org.jbpm.services.api.admin.TimerInstance
Returns session id that was used to create the timer
getSignals() - Method in interface org.jbpm.services.api.model.ProcessDefinition
Returns process definition signals.
getSlaCompliance() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
Returns the node instance SLA complience.
getSlaCompliance() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
Returns the process instance description SLA compliance.
getSlaCompliance() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Returns the user task SLA compliance.
getSlaDueDate() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
Returns the node instance SLA due date.
getSlaDueDate() - Method in interface org.jbpm.services.api.model.ProcessInstanceDesc
Returns the process instance description SLA due date.
getSlaDueDate() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Returns the user task SLA due date.
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
Returns the process instance description state.
getStatus() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Returns the user task instance status.
getStrategy() - Method in interface org.jbpm.services.api.model.DeploymentUnit
Returns the deployment unit runtime strategy.
getSubject() - Method in interface org.jbpm.services.api.admin.TaskNotification
Returns the subject line for this notification
getSubject() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Returns task subject
getSubject() - Method in interface org.jbpm.services.api.model.UserTaskInstanceWithPotOwnerDesc
Returns the user task subject
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
getTask(String, 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.
getTaskById(Long, boolean) - Method in interface org.jbpm.services.api.RuntimeDataService
Return a task by its taskId with SLA data if the withSLA param is true.
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
Returns the user task instance task id.
getTaskInputContentByTaskId(Long) - Method in interface org.jbpm.services.api.UserTaskService
Returns task input data of a task
getTaskInputContentByTaskId(String, 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
Returns the user task definition task input mappings.
getTaskNotifications(long, boolean) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Returns task notifications scheduled for given task
getTaskNotifications(String, long, boolean) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Returns task notifications scheduled for given task
getTaskOutputContentByTaskId(Long) - Method in interface org.jbpm.services.api.UserTaskService
Returns task output data currently stored, might be null of no data is stored
getTaskOutputContentByTaskId(String, 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
Returns the user task definition task output mappings.
getTaskReassignments(long, boolean) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Returns task reassignments scheduled for given task
getTaskReassignments(String, long, boolean) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Returns task reassignments scheduled for given task
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.
getTimerId() - Method in interface org.jbpm.services.api.admin.TimerInstance
Returns unique id of the timer
getTimerInstances(long) - Method in interface org.jbpm.services.api.admin.ProcessInstanceAdminService
Returns active timers for given process instance.
getTimerName() - Method in interface org.jbpm.services.api.admin.TimerInstance
Returns name of the timer - taken from timer node in the process
getTimers() - Method in interface org.jbpm.services.api.model.ProcessDefinition
Returns process definition timers.
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
Return the process definition type.
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.
getUniqueId() - Method in interface org.jbpm.services.api.model.NodeDesc
Returns the node description unique id.
getUniqueId() - Method in interface org.jbpm.services.api.model.TimerDesc
Returns the timer description unique id.
getUserGroupCallback() - Method in interface org.jbpm.services.api.utils.KieServiceConfigurator
Returns the user group callback.
getUserTaskService() - Method in interface org.jbpm.services.api.utils.KieServiceConfigurator
Returns the user task service.
getValue() - Method in class org.jbpm.services.api.query.model.QueryParam
Returns list of values.
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
Returns the variable id.
getVariableInstanceId() - Method in interface org.jbpm.services.api.model.VariableDesc
Returns the variable instance id.
getVariables() - Method in interface org.jbpm.services.api.model.ProcessInstanceWithVarsDesc
Returns process instance variables.
getVariables() - Method in interface org.jbpm.services.api.model.UserTaskInstanceWithVarsDesc
Returns the uer task variables
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
Returns the deployed asset version.
getVersion() - Method in interface org.jbpm.services.api.model.ProcessDefinition
Return the process definition version.
getWorkItem(Long) - Method in interface org.jbpm.services.api.ProcessService
Returns the specified workItem
getWorkItem(String, Long, 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.
getWorkItemByProcessInstance(String, 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
Returns the node instance workitem id.
getWorkItemId() - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Returns the user task workitem id.
greaterOrEqualTo(String, Comparable<?>) - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns the "greater than or equal" query parameter for given column and set of values.
greaterThan(String, Comparable<?>) - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns the "greater than" query parameter for given column and set of values.
groupBy(String) - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns the "group by" query parameters for given column.
groupBy(String, String, int) - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns the "group by" query parameters for given column, interval size and max interval.

H

HOUR - Static variable in class org.jbpm.services.api.query.model.QueryParam
 
HUNDRETH - Static variable in class org.jbpm.services.api.query.model.QueryParam
 

I

in(String, List<?>) - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns the "in" query parameter for given column and set of values.
in(String, Object...) - Static method in class org.jbpm.services.api.query.model.QueryParam
 
isActive() - Method in interface org.jbpm.services.api.admin.TaskNotification
Returns if given notification is active
isActive() - Method in interface org.jbpm.services.api.admin.TaskReassignment
Returns if given reassignment is active
isActive() - Method in interface org.jbpm.services.api.model.DeployedUnit
Returns the active state of the deployment unit.
isActive() - Method in interface org.jbpm.services.api.model.ProcessDefinition
Returns if process definition is active.
isCompleted() - Method in interface org.jbpm.services.api.model.NodeInstanceDesc
Returns the node instance completion.
isDeployed(String) - Method in interface org.jbpm.services.api.DeploymentService
Performs a check if given deployment is already active
isDynamic() - Method in interface org.jbpm.services.api.model.ProcessDefinition
Return if process definition is dynamic.
isNotNull(String) - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns "is not null" query parameter for given column.
isNull(String) - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns "is null" query parameter for given column.
isSkippable() - Method in interface org.jbpm.services.api.model.UserTaskDefinition
Returns the user task skippable.
isSuccessful() - Method in interface org.jbpm.services.api.admin.MigrationReport
Indicates if the migration was successful or not

K

KieServiceConfigurator - Interface in org.jbpm.services.api.utils
Configurator for kie service.

L

likeTo(String, boolean, Comparable<?>) - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns the "like to" query parameter for given column, case sensitivity and set of values.
list(QueryParam...) - Static method in class org.jbpm.services.api.query.model.QueryParam
 
ListenerSupport - Interface in org.jbpm.services.api
Provides means to add deployment event listeners to deployment service.
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
Returns the "loqer or equal to" query parameter for given column and set of values.
lowerThan(String, Comparable<?>) - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns the "lower than" query parameter for given column and set of values.

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.
max(String) - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns the "max" query parameter for given column.
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.
MIGRATION_SERVICE - Static variable in class org.jbpm.services.api.service.ServiceRegistry
 
MigrationEntry - Interface in org.jbpm.services.api.admin
Single migration step information.
MigrationReport - Interface in org.jbpm.services.api.admin
MigrationReport that provides details about performed steps during process instance migration.
MILLENIUM - Static variable in class org.jbpm.services.api.query.model.QueryParam
 
MILLISECOND - Static variable in class org.jbpm.services.api.query.model.QueryParam
 
min(String) - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns the "min" query parameter for given column.
MINUTE - Static variable in class org.jbpm.services.api.query.model.QueryParam
 
MONTH - Static variable in class org.jbpm.services.api.query.model.QueryParam
 

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
NodeDesc - Interface in org.jbpm.services.api.model
 
NodeInstanceDesc - Interface in org.jbpm.services.api.model
 
NodeInstanceNotFoundException - Exception in org.jbpm.services.api
 
NodeInstanceNotFoundException(String) - Constructor for exception org.jbpm.services.api.NodeInstanceNotFoundException
 
NodeInstanceNotFoundException(String, Throwable) - Constructor for exception org.jbpm.services.api.NodeInstanceNotFoundException
 
NodeNotFoundException - Exception in org.jbpm.services.api
 
NodeNotFoundException(String) - Constructor for exception org.jbpm.services.api.NodeNotFoundException
 
NodeNotFoundException(String, Throwable) - Constructor for exception org.jbpm.services.api.NodeNotFoundException
 
nominate(Long, String, List<OrganizationalEntity>) - Method in interface org.jbpm.services.api.UserTaskService
Nominate a task to be handled by potentialOwners
nominate(String, 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
Returns the "not equals to" query parameter for given column and set of values
notifyWhenNotCompleted(long, String, Notification) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Sends notification (of notification type) to given recipients in case task was not completed before time given as timeExpression elapses.
notifyWhenNotCompleted(String, long, String, Notification) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Sends notification (of notification type) to given recipients in case task was not completed before time given as timeExpression elapses.
notifyWhenNotStarted(long, String, Notification) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Sends notification (of notification type) to given recipients in case task was not started before time given as timeExpression elapses.
notifyWhenNotStarted(String, long, String, Notification) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Sends notification (of notification type) to given recipients in case task was not started before time given as timeExpression elapses.
notIn(String, List<?>) - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns the "not in" query parameter for given column and set of values.
notIn(String, Object...) - 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
 
org.jbpm.services.api.service - package org.jbpm.services.api.service
 
org.jbpm.services.api.utils - package org.jbpm.services.api.utils
 

P

PROCESS_ADMIN_SERVICE - Static variable in class org.jbpm.services.api.service.ServiceRegistry
 
PROCESS_ATTR_CORRELATION_KEY - Static variable in interface org.jbpm.services.api.AdvanceRuntimeDataService
 
PROCESS_ATTR_DEFINITION_ID - Static variable in interface org.jbpm.services.api.AdvanceRuntimeDataService
 
PROCESS_ATTR_DEPLOYMENT_ID - Static variable in interface org.jbpm.services.api.AdvanceRuntimeDataService
 
PROCESS_ATTR_INSTANCE_ID - Static variable in interface org.jbpm.services.api.AdvanceRuntimeDataService
 
PROCESS_SERVICE - Static variable in class org.jbpm.services.api.service.ServiceRegistry
 
ProcessDefinition - Interface in org.jbpm.services.api.model
 
ProcessDefinitionNotFoundException - Exception in org.jbpm.services.api
 
ProcessDefinitionNotFoundException(String) - Constructor for exception org.jbpm.services.api.ProcessDefinitionNotFoundException
 
ProcessDefinitionNotFoundException(String, Throwable) - Constructor for exception org.jbpm.services.api.ProcessDefinitionNotFoundException
 
ProcessDesc - Interface in org.jbpm.services.api.model
 
ProcessInstanceAdminService - Interface in org.jbpm.services.api.admin
Admin Service - provides runtime modifications capabilities for active process instances.
ProcessInstanceCustomDesc - 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
 
ProcessNode - Interface in org.jbpm.services.api.admin
Describes process node taken from process definition.
ProcessService - Interface in org.jbpm.services.api
 

Q

QUARTER - Static variable in class org.jbpm.services.api.query.model.QueryParam
 
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.
QUERY_SERVICE - Static variable in class org.jbpm.services.api.service.ServiceRegistry
 
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
 
QueryParam.Builder - Class in org.jbpm.services.api.query.model
Query Parameter Builder.
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
queryProcessByVariables(List<QueryParam>, List<QueryParam>, QueryContext) - Method in interface org.jbpm.services.api.AdvanceRuntimeDataService
 
queryProcessByVariablesAndTask(List<QueryParam>, List<QueryParam>, List<QueryParam>, List<String>, QueryContext) - Method in interface org.jbpm.services.api.AdvanceRuntimeDataService
 
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.
queryUserTasksByVariables(List<QueryParam>, List<QueryParam>, List<QueryParam>, List<String>, QueryContext) - Method in interface org.jbpm.services.api.AdvanceRuntimeDataService
 

R

reassignWhenNotCompleted(long, String, OrganizationalEntity...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Reassign automatically a task in case it was not completed before time given as timeExpression elapses.
reassignWhenNotCompleted(String, long, String, OrganizationalEntity...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Reassign automatically a task in case it was not completed before time given as timeExpression elapses.
reassignWhenNotStarted(long, String, OrganizationalEntity...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Reassign automatically a task in case it was not started before time given as timeExpression elapses.
reassignWhenNotStarted(String, long, String, OrganizationalEntity...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Reassign automatically a task in case it was not started before time given as timeExpression elapses.
register(String, Object) - Method in class org.jbpm.services.api.service.ServiceRegistry
Registers service under given name.
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
release(String, Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Release a previously claimed task
remove(String) - Method in class org.jbpm.services.api.service.ServiceRegistry
Removes service registered under given name
removeBusinessAdmins(long, OrganizationalEntity...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Remove existing business admin from given task.
removeBusinessAdmins(String, long, OrganizationalEntity...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Remove existing business admin from given task.
removeExcludedOwners(long, OrganizationalEntity...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Remove existing excluded owners from given task.
removeExcludedOwners(String, long, OrganizationalEntity...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Remove existing excluded owners from given task.
removeListener(DeploymentEventListener) - Method in interface org.jbpm.services.api.ListenerSupport
Removes an existing deployment listener.
removeMapper(String) - Method in class org.jbpm.services.api.query.QueryMapperRegistry
Removes a query results mapper.
removePotentialOwners(long, OrganizationalEntity...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Remove existing potential owners from given task.
removePotentialOwners(String, long, OrganizationalEntity...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Remove existing potential owners from given task.
removeTaskInputs(long, String...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Removes one or more input variables from a task.
removeTaskInputs(String, long, String...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Removes one or more input variables from a task.
removeTaskOutputs(long, String...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Removes one or more output variables from a task.
removeTaskOutputs(String, long, String...) - Method in interface org.jbpm.services.api.admin.UserTaskAdminService
Removes one or more output variables from a task.
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
resume(String, Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Resume a previously suspended task
retriggerNodeInstance(long, long) - Method in interface org.jbpm.services.api.admin.ProcessInstanceAdminService
Retriggers (which includes cancel) node instance given with node instance id within process instance.
RUNTIME_DATA_SERVICE - Static variable in class org.jbpm.services.api.service.ServiceRegistry
 
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
saveContent(String, 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
saveContentFromUser(Long, String, 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
SECOND - Static variable in class org.jbpm.services.api.query.model.QueryParam
 
service(String) - Method in class org.jbpm.services.api.service.ServiceRegistry
Retrieves service registered under given name
ServiceRegistry - Class in org.jbpm.services.api.service
Single ServiceRegistry that allows any service to register itself so other components can easily look them up.
services - Variable in class org.jbpm.services.api.service.ServiceRegistry
 
setColumn(String) - Method in class org.jbpm.services.api.query.model.QueryParam
Sets the column.
setDeployedUnit(DeployedUnit) - Method in class org.jbpm.services.api.DeploymentEvent
Sets the deployed unit.
setDeploymentId(String) - Method in class org.jbpm.services.api.DeploymentEvent
Sets the deployment id.
setDescription(Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Sets description of the task
setDescription(String, 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
setExpirationDate(String, 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
setName(String, 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
Sets the operator.
setPriority(Long, int) - Method in interface org.jbpm.services.api.UserTaskService
Sets priority of a task to given value
setPriority(String, 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.
setProcessVariable(String, 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.
setProcessVariables(String, 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
setSkipable(String, Long, boolean) - Method in interface org.jbpm.services.api.UserTaskService
Sets skipable property of a task to given value
setSlaCompliance(Integer) - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Set the user task SLA compliance.
setSlaDueDate(Date) - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Set the user task SLA due date.
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)
setSubject(String) - Method in interface org.jbpm.services.api.model.UserTaskInstanceDesc
Set task subject
setValue(List<?>) - Method in class org.jbpm.services.api.query.model.QueryParam
Sets the value.
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
signalProcessInstance(String, 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
signalProcessInstances(String, 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
skip(String, 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.
start(String, 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
startProcessFromNodeIds(String, String, Map<String, Object>, String...) - Method in interface org.jbpm.services.api.ProcessService
Starts a process with the values supplied from the current nodes
startProcessFromNodeIds(String, String, CorrelationKey, Map<String, Object>, String...) - Method in interface org.jbpm.services.api.ProcessService
Starts a process with the values supplied from the current nodes
stop(Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Cancel/stop the processing of the task.
stop(String, Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Cancel/stop the processing of the task.
sum(String) - Static method in class org.jbpm.services.api.query.model.QueryParam
Returns the "sum" query parameter for given column.
suspend(Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Suspend a claimed task.
suspend(String, Long, String) - Method in interface org.jbpm.services.api.UserTaskService
Suspend a claimed task.

T

TASK_ATTR_NAME - Static variable in interface org.jbpm.services.api.AdvanceRuntimeDataService
 
TASK_ATTR_OWNER - Static variable in interface org.jbpm.services.api.AdvanceRuntimeDataService
 
TASK_ATTR_STATUS - Static variable in interface org.jbpm.services.api.AdvanceRuntimeDataService
 
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
 
TaskNotification - Interface in org.jbpm.services.api.admin
 
TaskReassignment - Interface in org.jbpm.services.api.admin
 
taskSummaryQuery(String) - Method in interface org.jbpm.services.api.RuntimeDataService
Query on TaskSummary instaances.
TENTH - Static variable in class org.jbpm.services.api.query.model.QueryParam
 
TimerDesc - Interface in org.jbpm.services.api.model
 
TimerInstance - Interface in org.jbpm.services.api.admin
Describes timer instance that is active with details about the timer and the owner (such as process instance).
triggerNode(long, long) - Method in interface org.jbpm.services.api.admin.ProcessInstanceAdminService
Triggers node to create new node instance with node id within process instance.
type(String, Comparable<?>) - Static method in class org.jbpm.services.api.query.model.QueryParam
 

U

undeploy(DeploymentUnit) - Method in interface org.jbpm.services.api.DeploymentService
Performs undeployment operation of given unit.
undeploy(DeploymentUnit, Function<DeploymentUnit, Boolean>) - Method in interface org.jbpm.services.api.DeploymentService
Performs undeployment operation of given unit aborting existing process instances if needed.
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
Updates and existing task.
updateTask(Long, String, UserTaskInstanceDesc, Map<String, Object>, Map<String, Object>) - Method in interface org.jbpm.services.api.UserTaskService
Updates user task properties and data inputs and outputs.
updateTask(String, Long, String, UserTaskInstanceDesc, Map<String, Object>, Map<String, Object>) - Method in interface org.jbpm.services.api.UserTaskService
Updates user task properties and data inputs and outputs.
updateTimer(long, long, long, long, int) - Method in interface org.jbpm.services.api.admin.ProcessInstanceAdminService
Updates active timer identified by timer id with delay that is given in seconds.
updateTimerRelative(long, long, long, long, int) - Method in interface org.jbpm.services.api.admin.ProcessInstanceAdminService
Updates active timer identified by timer id with delay that is given in seconds and is relative to current time.
USER_TASK_ADMIN_SERVICE - Static variable in class org.jbpm.services.api.service.ServiceRegistry
 
USER_TASK_SERVICE - Static variable in class org.jbpm.services.api.service.ServiceRegistry
 
UserTaskAdminService - Interface in org.jbpm.services.api.admin
Provides administrative operations on top of active tasks.
UserTaskDefinition - Interface in org.jbpm.services.api.model
 
UserTaskInstanceDesc - Interface in org.jbpm.services.api.model
 
UserTaskInstanceWithPotOwnerDesc - 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

WEEK - Static variable in class org.jbpm.services.api.query.model.QueryParam
 
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
 

Y

YEAR - Static variable in class org.jbpm.services.api.query.model.QueryParam
 
A B C D E F G H I K L M N O P Q R S T U V W Y 
Skip navigation links
jBPM :: Services API 7.39.0.Final-redhat-00007

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