# Package org.activiti.engine

Public API of the Activiti engine.
Typical usage of the API starts by the creation of a `ProcessEngineConfiguration` (typically based on a configuration file), from which a `ProcessEngine` can be obtained.
Through the services obtained from such a `ProcessEngine`, BPM and workflow operation can be executed:
`RepositoryService`: Manages `Deployment`s
`RuntimeService`: For starting and searching `ProcessInstance`s
`TaskService`: Exposes operations to manage human (standalone) `Task`s, such as claiming, completing and assigning tasks
`IdentityService`: Used for managing `User`s, `Group`s and the relations between them
`ManagementService`: Exposes engine admin and maintenance operations, which have no relation to the runtime exection of business processes
`HistoryService`: Exposes information about ongoing and past process instances.
`FormService`: Access to form data and rendered forms for starting new process instances and completing tasks.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  DynamicBpmnConstants |
  DynamicBpmnService | Service providing access to the repository of process definitions and deployments.
  EngineServices | Interface implemented by all classes that expose the Activiti services.
  FormService | Access to form data and rendered forms for starting new process instances and completing tasks.
  HistoryService | Service exposing information about ongoing and past process instances.
  IdentityService | Service to manage `User`s and `Group`s.
  ManagementService | Service for admin and maintenance operations on the process engine.
  ProcessEngine | Provides access to all the services that expose the BPM and workflow operations.
  ProcessEngineInfo | Represents information about the initialization of the process engine.
  ProcessEngineLifecycleListener | Interface describing a listener that get's notified when certain event occurs, related to the process-engine lifecycle it is attached to.
  RepositoryService | Service providing access to the repository of process definitions and deployments.
  RuntimeService |
  TaskService | Service which provides access to `Task` and form related operations.

- Class Summary
  Class | Description
  --- | ---
  ProcessEngineConfiguration | Configuration information from which a process engine can be build.
  ProcessEngines | Helper for initializing and closing process engines in server environments.

- Exception Summary
  Exception | Description
  --- | ---
  ActivitiClassLoadingException | Runtime exception indicating the requested class was not found or an error occurred while loading the class.
  ActivitiException | Runtime exception that is the superclass of all Activiti exceptions.
  ActivitiIllegalArgumentException | An exception indicating that an illegal argument has been supplied in an Activiti API-call, an illegal value was configured in the engine's configuration or an illegal value has been supplied or an illegal value is used in a process-definition.
  ActivitiObjectNotFoundException | An exception indicating that the object that is required or actioned on does not exist.
  ActivitiOptimisticLockingException | Exception that is thrown when an optimistic locking occurs in the datastore caused by concurrent access of the same data entry.
  ActivitiTaskAlreadyClaimedException | This exception is thrown when you try to claim a task that is already claimed by someone else.
  ActivitiWrongDbException | Exception that is thrown when the Activiti engine discovers a mismatch between the database schema version and the engine version.
  JobNotFoundException | This exception is thrown when you try to execute a job that is not found (may be due to cancelActiviti="true" for instance)..

## Package org.activiti.engine Description

Public API of the Activiti engine.
Typical usage of the API starts by the creation of a `ProcessEngineConfiguration` (typically based on a configuration file), from which a `ProcessEngine` can be obtained.
Through the services obtained from such a `ProcessEngine`, BPM and workflow operation can be executed:
`RepositoryService`: Manages `Deployment`s
`RuntimeService`: For starting and searching `ProcessInstance`s
`TaskService`: Exposes operations to manage human (standalone) `Task`s, such as claiming, completing and assigning tasks
`IdentityService`: Used for managing `User`s, `Group`s and the relations between them
`ManagementService`: Exposes engine admin and maintenance operations, which have no relation to the runtime exection of business processes
`HistoryService`: Exposes information about ongoing and past process instances.
`FormService`: Access to form data and rendered forms for starting new process instances and completing tasks.

Copyright © 2016 Alfresco. All rights reserved.