Package | Description |
---|---|
com.bonitasoft.engine.api |
The Bonita BPM project has a clear separation between the API the users should be interacting with and the actual implementation classes.
|
org.bonitasoft.engine.api |
The Bonita BPM project has a clear separation between the API the users should be interacting with and the actual implementation classes.
|
org.bonitasoft.engine.exception |
Modifier and Type | Method and Description |
---|---|
void |
ProcessManagementAPI.setConnectorImplementation(long processDefinitionId,
String connectorName,
String connectorVersion,
byte[] connectorImplementationArchive)
Updates the implementation version of the connector of the process definition.
|
void |
ProcessManagementAPI.setConnectorInstanceState(long connectorInstanceId,
ConnectorStateReset state)
Allows to reset the state of an instance of connector
|
void |
ProcessManagementAPI.setConnectorInstanceState(Map<Long,ConnectorStateReset> connectorsToReset)
Allows to reset connector instance states for a Collection of connector instances at once.
|
void |
ProcessManagementAPI.updateExpressionContent(long processDefintionId,
long expressionDefinitionId,
String content)
Updates an expression content at runtime, for all instances of a given process definition.
|
FormMapping |
ProcessManagementAPI.updateFormMapping(long formMappingId,
String url,
Long pageId)
Update a form mapping with the given values
|
void |
ProcessManagementAPI.updateParameterInstanceValue(long processDefinitionId,
String parameterName,
String parameterValue)
Update an existing parameter of a process definition.
|
ProcessInstance |
ProcessRuntimeAPI.updateProcessInstance(long processInstanceId,
ProcessInstanceUpdater updater)
Update an instance of process with the given processInstanceId.
|
ProcessInstance |
ProcessRuntimeAPI.updateProcessInstanceIndex(long processInstanceId,
Index index,
String value)
Update an index of a process instance.
|
Profile |
ProfileAPI.updateProfile(long id,
ProfileUpdater updater)
Update a custom profile.
|
ProfileEntry |
ProfileAPI.updateProfileEntry(long id,
ProfileEntryUpdater updater)
Update a profile entry.
|
Tenant |
PlatformAPI.updateTenant(long tenantId,
TenantUpdater updater)
Update a tenant with its tenantId and new content.
|
Modifier and Type | Method and Description |
---|---|
void |
ProcessRuntimeAPI.assignUserTask(long userTaskId,
long userId)
Assign a task to a user with given user identifier.
|
void |
ProcessRuntimeAPI.cancelProcessInstance(long processInstanceId)
Cancels the process instance and all of its active flow nodes.
|
void |
TenantAdministrationAPI.pause()
Pause the tenant so nothing is executed anymore.
|
void |
ProcessManagementAPI.purgeClassLoader(long processDefinitionId)
Purges the classLoader of the process definition.
|
void |
ProcessRuntimeAPI.releaseUserTask(long userTaskId)
Release a task (unclaim or unassign).
|
void |
PlatformAPI.rescheduleErroneousTriggers()
Reschedules triggers which are in error state.
|
void |
TenantAdministrationAPI.resume()
Resume the tenant to a normal state after a pause.
|
void |
ProcessRuntimeAPI.setActivityStateById(long activityInstanceId,
int stateId)
Set the state of an activity instance.
|
void |
ProcessRuntimeAPI.setActivityStateByName(long activityInstanceId,
String state)
Set the state of an activity instance.
|
void |
ApplicationAPI.setApplicationHomePage(long applicationId,
long applicationPageId)
Defines which
ApplicationPage will represent the Application home page |
CustomUserInfoValue |
CustomUserInfoAPI.setCustomUserInfoValue(long definitionId,
long userId,
String value)
Defines the value of a
CustomUserInfoDefinition for a given User . |
void |
ProcessRuntimeAPI.setProcessInstanceState(ProcessInstance processInstance,
String state)
Set a state of a process instance.
|
void |
ProcessRuntimeAPI.setTaskPriority(long userTaskInstanceId,
TaskPriority priority)
Set the priority of a user task.
|
void |
CommandAPI.update(long commandId,
CommandUpdater updateDescriptor)
Update a command according to the update descriptor.
|
void |
PlatformCommandAPI.update(String name,
CommandUpdater updater)
Updates a command according to the update descriptor.
|
void |
CommandAPI.update(String name,
CommandUpdater updateDescriptor)
Update a command according to the update descriptor.
|
void |
ProcessRuntimeAPI.updateActivityDataInstance(String dataName,
long activityInstanceId,
Serializable dataValue)
Update the value of a named data instance in a specified activity instance.
WARNING: this method is not supported for updating a Custom Data Instance variable with a remote Engine API connection, because the custom data type is not present in the remote classloader that deserializes the API call parameters. |
void |
ProcessRuntimeAPI.updateActivityInstanceVariables(List<Operation> operations,
long activityInstanceId,
Map<String,Serializable> expressionContexts)
Update the values of variables in an activity instance using expressions.
|
void |
ProcessRuntimeAPI.updateActivityInstanceVariables(long activityInstanceId,
Map<String,Serializable> variables)
Update the given variables of an activity instance.
|
void |
ProcessRuntimeAPI.updateActivityTransientDataInstance(String dataName,
long activityInstanceId,
Serializable dataValue)
Update the value of a named transient data instance in a specified activity instance.
|
ActorInstance |
ProcessManagementAPI.updateActor(long actorId,
ActorUpdater actorUpdater)
Updates the actor.
|
void |
ProcessRuntimeAPI.updateActorsOfUserTask(long userTaskId)
Updates the actors of the user task.
|
Application |
ApplicationAPI.updateApplication(long applicationId,
ApplicationUpdater updater)
Updates an
Application based on the information supplied by the ApplicationUpdater |
ApplicationMenu |
ApplicationAPI.updateApplicationMenu(long applicationMenuId,
ApplicationMenuUpdater updater)
Updates an
ApplicationMenu based on the information supplied by the
ApplicationMenuUpdater . |
void |
ProcessManagementAPI.updateCategory(long categoryId,
CategoryUpdater updater)
Updates the category according to the updater values.
|
void |
PlatformAPI.updateClientTenantConfigurationFile(long tenantId,
String file,
byte[] content)
INTERNAL USE ONLY
update a single client configuration file of the tenant
|
void |
ProcessRuntimeAPI.updateDueDateOfTask(long userTaskId,
Date dueDate)
Update the due date of a task.
|
Date |
ProcessRuntimeAPI.updateExecutionDateOfTimerEventTriggerInstance(long timerEventTriggerInstanceId,
Date executionDate)
Change the date of the execution of a specific
TimerEventTriggerInstance . |
Group |
GroupAPI.updateGroup(long groupId,
GroupUpdater updater)
Updates the group according to the updater values.
|
Page |
PageAPI.updatePage(long pageId,
PageUpdater pageUpdater)
Updates a custom page.
|
void |
PageAPI.updatePageContent(long pageId,
byte[] content)
Updates a custom page content.
|
void |
ProcessRuntimeAPI.updateProcessDataInstance(String dataName,
long processInstanceId,
Serializable dataValue)
Update the value of a named data item in a specified process instance.
|
void |
ProcessRuntimeAPI.updateProcessDataInstances(long processInstanceId,
Map<String,Serializable> dataNameValues)
Update the value of a named data item in a specified process instance.
|
void |
ProcessManagementAPI.updateProcessDeploymentInfo(long processDefinitionId,
ProcessDeploymentInfoUpdater processDeploymentInfoUpdater)
Updates the process deployment information for a specified process.
|
Role |
RoleAPI.updateRole(long roleId,
RoleUpdater updater)
Updates the group according to the updater values.
|
User |
UserAPI.updateUser(long userId,
UserUpdater updater)
Updates the user according to the updater values.
|
UserMembership |
MembershipAPI.updateUserMembership(long userMembershipId,
long newGroupId,
long newRoleId)
Changes the association of the user membership.
|
Modifier and Type | Class and Description |
---|---|
class |
UpdatingWithInvalidPageTokenException |
class |
UpdatingWithInvalidPageZipContentException |
Copyright © 2017 Bonitasoft S.A.. All rights reserved.