Uses of Package
org.bonitasoft.engine.api

Packages that use org.bonitasoft.engine.api

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.api.permission
org.bonitasoft.engine.connector
org.bonitasoft.engine.filter
org.bonitasoft.engine.util

Classes in org.bonitasoft.engine.api used by com.bonitasoft.engine.api

Class and Description
APIAccessor Gives access to some common APIs.
APIClient Bonita BPM Community Edition APIs client. IdentityAPI, ProcessAPI, ThemeAPI CommandAPI, ProfileAPI, TenantAdministrationAPI, PageAPI, ApplicationAPI, PermissionAPI, BusinessDataAPI,
ApplicationAPI This API allows to list and manage Bonita Living Applications (Application).
BusinessDataAPI Deprecated. Replaced by ProcessRuntimeAPI.getProcessInstanceExecutionContext(long) (ProcessRuntimeAPI.getArchivedProcessInstanceExecutionContext(long) for archived process instances). In the map return by ProcessRuntimeAPI.getProcessInstanceExecutionContext(long) you can get BusinessDataReference by using "yourBusinessDataName_ref" key (business data name as declared in the process definition followed by "_ref" suffix).
CommandAPI Manipulate tenant commands.
IdentityAPI The Interface IdentityAPI.
ImportStatus This object represents the status of the import of an entity e.g.
LoginAPI The LoginAPI allows to log in (and out) onto the Engine.
NoSessionRequired Indicates that a Bonita API method does not need to have a valid session to be called.
PageAPI This API gives access to all page features.
PlatformAPI Manage the platform.
PlatformCommandAPI Manipulates a platform command.
PlatformLoginAPI Manage the login on the platform.
ProcessAPI Contains all methods that handle processes.
ProcessManagementAPI This API deals with definition objects such as ProcessDefinition, ProcessDeploymentInfo, Category, ...
ProcessRuntimeAPI ProcessRuntimeAPI deals with Process runtime notions such as starting a new instance of a process, retrieving and executing tasks, accessing to all types of tasks, assigning a user to a task, retrieving archived versions of a task, accessing / updating data / variable values, adding / retrieving process comments ...
ProfileAPI Profiles are a notion used in BonitaBPM Portal to give and control access to some specific features of the Bonita BPM suite.
TenantAdministrationAPI This API gives access to tenant management.
ThemeAPI Manage mobile and portal theme.

Classes in org.bonitasoft.engine.api used by org.bonitasoft.engine.api

Class and Description
ApiAccessType
ApplicationAPI This API allows to list and manage Bonita Living Applications (Application).
BusinessDataAPI Deprecated. Replaced by ProcessRuntimeAPI.getProcessInstanceExecutionContext(long) (ProcessRuntimeAPI.getArchivedProcessInstanceExecutionContext(long) for archived process instances). In the map return by ProcessRuntimeAPI.getProcessInstanceExecutionContext(long) you can get BusinessDataReference by using "yourBusinessDataName_ref" key (business data name as declared in the process definition followed by "_ref" suffix).
CommandAPI Manipulate tenant commands.
CustomUserInfoAPI CustomUserInfoAPI forms part of the OrganizationAPI and gives access to all the Administration operations available on CustomUserInfoDefinition and CustomUserInfoValue: creation, deletion and retrieve methods
DocumentAPI Manipulate documents that are attached to a process instance.
GroupAPI GroupAPI forms part of the OrganizationAPI and gives access to all the Administration operations available on Groups: creation, deletion, updating, search, etc...
IdentityAPI The Interface IdentityAPI.
ImportError
ImportError.Type
ImportStatus This object represents the status of the import of an entity e.g.
ImportStatus.Status
Internal Element annotated with @Internal are for internal usage only and may change without any warning
LoginAPI The LoginAPI allows to log in (and out) onto the Engine.
MembershipAPI MembershipAPI forms part of the OrganizationAPI and gives access to all the Administration operations available on UserMemberships: creation, deletion, updating, retrieval, etc...
NoSessionRequired Indicates that a Bonita API method does not need to have a valid session to be called.
OrganizationAPI Manages the Organization, that is the users, groups, roles, memberships, through import / export methods.
PageAPI This API gives access to all page features.
PermissionAPI Handle permissions of users
PlatformAPI Manage the platform.
ProcessAPI Contains all methods that handle processes.
ProcessManagementAPI This API deals with definition objects such as ProcessDefinition, ProcessDeploymentInfo, Category, ...
ProcessRuntimeAPI ProcessRuntimeAPI deals with Process runtime notions such as starting a new instance of a process, retrieving and executing tasks, accessing to all types of tasks, assigning a user to a task, retrieving archived versions of a task, accessing / updating data / variable values, adding / retrieving process comments ...
ProfileAPI Profiles are a notion used in BonitaBPM Portal to give and control access to some specific features of the Bonita BPM suite.
RoleAPI RoleAPI forms part of the OrganizationAPI and gives access to all the Administration operations available on Roles: creation, deletion, search, etc...
TenantAdministrationAPI This API gives access to tenant management.
ThemeAPI Manage mobile and portal theme.
UserAPI UserAPI forms part of the OrganizationAPI and gives access to all the Administration operations available on Users: creation, deletion, certain specific getXXX() methods, generic search methods, etc...

Classes in org.bonitasoft.engine.api used by org.bonitasoft.engine.api.permission

Class and Description
APIAccessor Gives access to some common APIs.
Logger A logger given to PermissionRule

Classes in org.bonitasoft.engine.api used by org.bonitasoft.engine.connector

Class and Description
APIAccessor Gives access to some common APIs.

Classes in org.bonitasoft.engine.api used by org.bonitasoft.engine.filter

Class and Description
APIAccessor Gives access to some common APIs.

Classes in org.bonitasoft.engine.api used by org.bonitasoft.engine.util

Class and Description
ApiAccessType