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.
|
com.bonitasoft.engine.bdm |
Provides classes and interfaces for business data models (BDM).
|
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 |
---|---|
ManualTaskInstance |
ProcessRuntimeAPI.addManualUserTask(ManualTaskCreator creator)
Add a manual task with given human task id.
|
Application |
ApplicationAPI.createApplication(ApplicationCreator applicationCreator)
Deprecated.
Creates a new
Application based on the supplied ApplicationCreator |
ApplicationMenu |
ApplicationAPI.createApplicationMenu(ApplicationMenuCreator applicationMenuCreator)
Deprecated.
Creates a
ApplicationMenu based on the supplied ApplicationMenuCreator . |
ApplicationPage |
ApplicationAPI.createApplicationPage(long applicationId,
long pageId,
String token)
Deprecated.
Creates an
ApplicationPage |
Page |
PageAPI.createPage(PageCreator pageCreator,
byte[] content)
Deprecated.
Creates a custom page.
|
Page |
PageAPI.createPage(String contentName,
byte[] content)
Deprecated.
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
|
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.
|
ProfileEntry |
ProfileAPI.createProfileEntry(ProfileEntryCreator creator)
Create a new profile entry
|
ProfileEntry |
ProfileAPI.createProfileEntry(String name,
String description,
long profileId,
String type)
Create a new profile entry
|
ProfileEntry |
ProfileAPI.createProfileEntry(String name,
String description,
long profileId,
String type,
String page)
Create a new profile entry
|
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
|
Modifier and Type | Class and Description |
---|---|
class |
BusinessObjectDaoCreationException
Deprecated.
from version 7.0.0 on, use
BusinessObjectDaoCreationException instead. |
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.
|
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.
|
Comment |
ProcessRuntimeAPI.addProcessComment(long processInstanceId,
String comment)
Add a comment on a process instance.
|
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.
|
ActorMember |
ProcessManagementAPI.addRoleAndGroupToActor(long actorId,
long roleId,
long groupId)
Maps the role and the group to the actor.
|
ActorMember |
ProcessManagementAPI.addRoleAndGroupToActor(String actorName,
ProcessDefinition processDefinition,
long roleId,
long groupId)
Maps the role and the group to the actor of the process definition.
|
ActorMember |
ProcessManagementAPI.addRoleToActor(long actorId,
long roleId)
Maps the role to the actor.
|
ActorMember |
ProcessManagementAPI.addRoleToActor(String actorName,
ProcessDefinition processDefinition,
long roleId)
Maps the role to the actor of the process definition.
|
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.
|
void |
PlatformAPI.createAndInitializePlatform()
Deprecated.
since 7.3.0. Use
PlatformAPI.initializePlatform() instead. |
Application |
ApplicationAPI.createApplication(ApplicationCreator applicationCreator)
Creates a new
Application based on the supplied ApplicationCreator |
ApplicationMenu |
ApplicationAPI.createApplicationMenu(ApplicationMenuCreator applicationMenuCreator)
Creates a
ApplicationMenu based on the supplied ApplicationMenuCreator . |
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
|
void |
PlatformAPI.createPlatform()
Deprecated.
since 7.3.0. Use
PlatformAPI.initializePlatform() instead. |
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.
|
void |
PlatformAPI.initializePlatform()
Initialize the platform.
The running environment of Bonita Engine is initialized and marked as activated.
Business elements linked to the execution are initialized, after this step the technical user will be able to connect to the engine and to import the |
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.
|
Modifier and Type | Class and Description |
---|---|
class |
AlreadyExistsException
Thrown when it's not possible to create a object, because it already exists.
|
class |
InvalidPageTokenException |
class |
InvalidPageZipContentException |
class |
InvalidPageZipInconsistentException |
class |
InvalidPageZipMissingAPropertyException |
class |
InvalidPageZipMissingIndexException |
class |
InvalidPageZipMissingPropertiesException |
Copyright © 2016 Bonitasoft S.A.. All rights reserved.