Package | Description |
---|---|
com.bonitasoft.engine.api |
The Bonita 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 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 |
ProcessRuntimeAPI.deleteManualUserTask(long manualTaskId)
Delete a manual task.
|
void |
ProfileAPI.deleteProfile(long id)
Delete a specific custom profile
|
void |
ProfileAPI.deleteProfileEntry(long id)
Delete a specific profile entry
|
void |
ReportingAPI.deleteReport(long reportId)
Deletes a report identified by its ID.
|
void |
ReportingAPI.deleteReports(List<Long> reportIds)
Deletes a list of reports, given by their IDs.
|
void |
PlatformAPI.deleteTenant(long tenantId)
Delete a tenant.
|
Modifier and Type | Method and Description |
---|---|
void |
PlatformAPI.cleanAndDeletePlaftorm()
Deprecated.
since 6.5.0 (typo in method name). Use
PlatformAPI.cleanPlatform() instead. |
void |
PlatformAPI.cleanAndDeletePlatform()
Deprecated.
since 7.3.0. Use
PlatformAPI.cleanPlatform() instead. |
void |
PlatformAPI.cleanPlatform()
Clean the platform.
|
void |
ApplicationAPI.deleteApplication(long applicationId)
Deletes an
Application by its identifier. |
void |
ApplicationAPI.deleteApplicationMenu(long applicationMenuId)
Deletes an
ApplicationMenu by its identifier. |
void |
ApplicationAPI.deleteApplicationPage(long applicationPageId)
Deletes an
ApplicationPage by its identifier. |
long |
ProcessRuntimeAPI.deleteArchivedProcessInstances(long processDefinitionId,
int startIndex,
int maxResults)
Delete archived process instances of process definition given as input parameter respecting the pagination parameters.
|
long |
ProcessRuntimeAPI.deleteArchivedProcessInstancesInAllStates(List<Long> sourceProcessInstanceIds)
Delete all archived process instance (different states) of the source identifier list.
|
long |
ProcessRuntimeAPI.deleteArchivedProcessInstancesInAllStates(long sourceProcessInstanceId)
Delete all archived process instance (different states) corresponding to the source identifier.
|
void |
ProcessManagementAPI.deleteCategory(long categoryId)
Deletes a category and its associations.
|
void |
CustomUserInfoAPI.deleteCustomUserInfoDefinition(long id)
Deletes the
CustomUserInfoDefinition identified by the given id. |
void |
GroupAPI.deleteGroup(long groupId)
Deletes the group.
|
void |
GroupAPI.deleteGroups(List<Long> groupIds)
Deletes the groups.
|
void |
OrganizationAPI.deleteOrganization()
Deletes the organization.
|
void |
PageAPI.deletePage(long pageId)
Deletes a page identified by its ID.
|
void |
PageAPI.deletePages(List<Long> pageIds)
Deletes a list of pages, given by their IDs.
|
void |
PlatformAPI.deletePlatform()
Deprecated.
since 7.3.0. Use
PlatformAPI.cleanPlatform() instead. |
void |
ProcessManagementAPI.deleteProcessDefinition(long processDefinitionId)
Deletes a process definition by giving its identifier.
|
void |
ProcessManagementAPI.deleteProcessDefinitions(List<Long> processDefinitionIds)
Deletes process definitions by giving their identifiers.
|
void |
ProcessRuntimeAPI.deleteProcessInstance(long processInstanceId)
Delete the specified process instance.
|
long |
ProcessRuntimeAPI.deleteProcessInstances(long processDefinitionId,
int startIndex,
int maxResults)
Delete active process instances, and their elements, of process definition given as input parameter respecting the pagination parameters.
|
void |
ProfileAPI.deleteProfileMember(Long id)
Deletes the profile member.
|
void |
RoleAPI.deleteRole(long roleId)
Deletes the role.
|
void |
RoleAPI.deleteRoles(List<Long> roleIds)
Deletes the roles.
|
void |
ProcessManagementAPI.deleteSupervisor(long supervisorId)
Deletes a process supervisor.
|
void |
ProcessManagementAPI.deleteSupervisor(Long processDefinitionId,
Long userId,
Long roleId,
Long groupId)
Delete the
ProcessSupervisor object that is identified by this processDefinitionId, userId, roleId and groupId. |
void |
UserAPI.deleteUser(long userId)
Deletes the user.
|
void |
UserAPI.deleteUser(String userName)
Deletes the user.
|
void |
MembershipAPI.deleteUserMembership(long userMembershipId)
Deletes the user membership.
|
void |
MembershipAPI.deleteUserMembership(long userId,
long groupId,
long roleId)
Deletes the user membership.
|
void |
MembershipAPI.deleteUserMemberships(List<Long> userIds,
long groupId,
long roleId)
Deletes the user memberships.
|
void |
UserAPI.deleteUsers(List<Long> userIds)
Deletes the users.
|
void |
ProcessManagementAPI.disableAndDeleteProcessDefinition(long processDefinitionId)
Disables and deletes the process.
|
void |
ProcessManagementAPI.removeActorMember(long actorMemberId)
Deletes the actor member.
|
void |
ProcessManagementAPI.removeCategoriesFromProcess(long processDefinitionId,
List<Long> categoryIds)
Dissociates the categories from the process definition.
|
long |
ProcessManagementAPI.removeCategoriesFromProcessDefinition(long processDefinitionId,
int startIndex,
int maxResults)
Deletes the associations of categories related the process definition given as input parameter respecting the pagination parameters.
|
void |
PlatformCommandAPI.removeDependency(String name)
Removes the dependency.
|
void |
CommandAPI.removeDependency(String name)
Remove a dependency to the tenant scope.
|
Document |
DocumentAPI.removeDocument(long documentId)
Remove the document with the specified identifier and returns it.
|
long |
ProcessManagementAPI.removeProcessDefinitionsFromCategory(long categoryId,
int startIndex,
int maxResults)
Deletes the associations of all the process definitions related to the category given as input parameter respecting the pagination parameters.
|
void |
CommandAPI.unregister(long commandId)
Delete a command through its id.
|
void |
PlatformCommandAPI.unregister(String name)
Deletes a command and its descriptor.
|
void |
CommandAPI.unregister(String name)
Delete a command through its name.
|
void |
CommandAPI.unregisterAll()
Delete all commands.
|
Modifier and Type | Class and Description |
---|---|
class |
ProcessInstanceHierarchicalDeletionException
Happens when a process instance can't be there is a parent process instance that is still active
Delete this parent process first.
|
Copyright © 2018 Bonitasoft S.A.. All rights reserved.