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.
|
Modifier and Type | Method and Description |
---|---|
ManualTaskInstance |
ProcessRuntimeAPI.addManualUserTask(ManualTaskCreator creator)
Add a manual task with given human task id.
|
Profile |
ProfileAPI.createProfile(ProfileCreator creator)
Create a new custom profile
|
Profile |
ProfileAPI.createProfile(String name,
String description)
Create a new custom profile
|
Profile |
ProfileAPI.createProfile(String name,
String description,
String iconPath)
Deprecated.
|
Report |
ReportingAPI.createReport(ReportCreator reportCreator,
byte[] content)
Creates a custom report.
|
Report |
ReportingAPI.createReport(String name,
String description,
byte[] content)
Creates a new report with no screenshot.
|
long |
PlatformAPI.createTenant(TenantCreator tenantCreator)
Create a new tenant
|
Profile |
ProfileAPI.updateProfile(long id,
ProfileUpdater updater)
Update a custom profile.
|
Modifier and Type | Method and Description |
---|---|
void |
ProcessManagementAPI.addCategoriesToProcess(long processDefinitionId,
List<Long> categoryIds)
Associates the categories to the process definition.
|
void |
PlatformCommandAPI.addDependency(String name,
byte[] jar)
Adds a dependency.
|
void |
CommandAPI.addDependency(String name,
byte[] jar)
Add a dependency to the tenant scope.
|
Document |
DocumentAPI.addDocument(long processInstanceId,
String documentName,
String description,
DocumentValue documentValue)
Attach a new document to a process instance.
|
ActorMember |
ProcessManagementAPI.addGroupToActor(long actorId,
long groupId)
Maps the group to the actor.
|
ActorMember |
ProcessManagementAPI.addGroupToActor(String actorName,
long groupId,
ProcessDefinition processDefinition)
Maps the group to the actor of the process definition.
|
void |
ProcessManagementAPI.addProcessDefinitionsToCategory(long categoryId,
List<Long> processDefinitionIds)
Associates a list of process definitions with the category.
|
void |
ProcessManagementAPI.addProcessDefinitionToCategory(long categoryId,
long processDefinitionId)
Associates the process definition with the category.
|
UserMembership |
MembershipAPI.addUserMembership(long userId,
long groupId,
long roleId)
Associates the user with the group and the role.
|
void |
MembershipAPI.addUserMemberships(List<Long> userIds,
long groupId,
long roleId)
Associates the users with the group and the role.
|
ActorMember |
ProcessManagementAPI.addUserToActor(long actorId,
long userId)
Maps the user to the actor.
|
ActorMember |
ProcessManagementAPI.addUserToActor(String actorName,
ProcessDefinition processDefinition,
long userId)
Maps a user to the actor of the process definition.
|
Application |
ApplicationAPI.createApplication(ApplicationCreator applicationCreator)
Creates a new
Application based on the supplied ApplicationCreator |
ApplicationPage |
ApplicationAPI.createApplicationPage(long applicationId,
long pageId,
String token)
Creates an
ApplicationPage |
Category |
ProcessManagementAPI.createCategory(String name,
String description)
Adds a category.
|
CustomUserInfoDefinition |
CustomUserInfoAPI.createCustomUserInfoDefinition(CustomUserInfoDefinitionCreator creator)
Creates a new
CustomUserInfoDefinition that will be available for all User
s in the organization. |
Group |
GroupAPI.createGroup(GroupCreator creator)
Creates a group.
|
Group |
GroupAPI.createGroup(String name,
String parentPath)
Creates a group from its name and parent path.
|
Page |
PageAPI.createPage(PageCreator pageCreator,
byte[] content)
Creates a custom page.
|
Page |
PageAPI.createPage(String contentName,
byte[] content)
create a page using the given content
the content must contain a page.properties file that contains informations on the page:
name, displayName and description
|
ProcessSupervisor |
ProcessManagementAPI.createProcessSupervisorForGroup(long processDefinitionId,
long groupId)
Adds the group as a supervisor of the process.
|
ProcessSupervisor |
ProcessManagementAPI.createProcessSupervisorForMembership(long processDefinitionId,
long groupId,
long roleId)
Adds the membership as a supervisor of the process.
|
ProcessSupervisor |
ProcessManagementAPI.createProcessSupervisorForRole(long processDefinitionId,
long roleId)
Adds the role as a supervisor of the process.
|
ProcessSupervisor |
ProcessManagementAPI.createProcessSupervisorForUser(long processDefinitionId,
long userId)
Adds the user as a supervisor of the process.
|
ProfileMember |
ProfileAPI.createProfileMember(Long profileId,
Long userId,
Long groupId,
Long roleId)
Creates a profile member.
|
ProfileMember |
ProfileAPI.createProfileMember(ProfileMemberCreator creator)
Creates a profile member.
|
Role |
RoleAPI.createRole(RoleCreator creator)
Create the role.
|
Role |
RoleAPI.createRole(String roleName)
Creates a role.
|
User |
UserAPI.createUser(String userName,
String password)
Creates a user.
|
User |
UserAPI.createUser(String userName,
String password,
String firstName,
String lastName)
Creates a user.
|
User |
UserAPI.createUser(UserCreator creator)
Creates a user.
|
ProcessDefinition |
ProcessManagementAPI.deploy(BusinessArchive businessArchive)
Deploys a
BusinessArchive which contains a DesignProcessDefinition and its dependencies. |
ProcessDefinition |
ProcessManagementAPI.deploy(DesignProcessDefinition designProcessDefinition)
Deploys a simple
DesignProcessDefinition (without any dependencies). |
ProcessDefinition |
ProcessManagementAPI.deployAndEnableProcess(BusinessArchive businessArchive)
Deploys and enables a process by giving a
BusinessArchive . |
ProcessDefinition |
ProcessManagementAPI.deployAndEnableProcess(DesignProcessDefinition designProcessDefinition)
Deploys, enables and returns a process.
|
Properties |
PageAPI.getPageProperties(byte[] content,
boolean checkIfItAlreadyExists)
Read the content of the page zip file check it is consistent and return it's properties
|
List<ImportStatus> |
ApplicationAPI.importApplications(byte[] xmlContent,
ApplicationImportPolicy policy)
Imports
Application s based on a XML file content. |
CommandDescriptor |
PlatformCommandAPI.register(String name,
String description,
String implementation)
Adds a command and its descriptor.
|
CommandDescriptor |
CommandAPI.register(String name,
String description,
String implementation)
Create a new command.
|
Application |
ApplicationAPI.updateApplication(long applicationId,
ApplicationUpdater updater)
Updates an
Application based on the information supplied by the ApplicationUpdater |
Document |
DocumentAPI.updateDocument(long documentId,
DocumentValue documentValue)
Attach a new document version to a process instance.
|
Page |
PageAPI.updatePage(long pageId,
PageUpdater pageUpdater)
Updates a custom page.
|
Copyright © 2017 Bonitasoft S.A.. All rights reserved.