Overview (edoras one Java API (2.0.0))

Packages
Package	Description
com.edorasware.api.action	Work object action support.
com.edorasware.api.annotation	Semantic annotations describing the intended use of API interfaces.
com.edorasware.api.base	Basic classes and values used by the rest of the API.
com.edorasware.api.config	Interfaces supporting customizable Spring configurations.
com.edorasware.api.config.action	Customization for the work object action configuration.
com.edorasware.api.config.engine	Customization for the Flowable-based execution engine configuration.
com.edorasware.api.config.i18n	Customization for the message internationalization configuration.
com.edorasware.api.config.mail	Customization for the mail configuration.
com.edorasware.api.config.persistence	Customization for the persistence layer configuration.
com.edorasware.api.config.property	Customization for the property configuration.
com.edorasware.api.config.security	Customization for the HTTP security configuration.
com.edorasware.api.document	Provides definitions and functionality specific to document work objects.
com.edorasware.api.exception	Exceptions that can be thrown by the public Java API.
com.edorasware.api.expression	Expression support.
com.edorasware.api.query	Work object query support.
com.edorasware.api.rest	Interfaces related to the public REST API.
com.edorasware.api.time	Time and date support.
com.edorasware.api.timer	Provides definitions and functionality specific to timer work objects.
com.edorasware.api.util	Utility interfaces and classes.
com.edorasware.api.value	Work object value access.
com.edorasware.api.web	Basic classes and values used by the web interface.
com.edorasware.api.workobject	Interfaces for work object access and manipulation.

The edoras one Java API defines the services that can be used by application developers to create applications using the edoras one platform.

Package structure

The classes making up the edoras one Java API are defined in the package com.edorasware.api. This package has a number of sub-packages to group API interfaces into functional groups, e.g.:

com.edorasware.api.elastic: for Elasticsearch integration
com.edorasware.api.workobject: for work object services

Any internal packages (e.g. com.edorasware.api.query.internal) are not part of the public API and should not be referenced in application code.

API Annotations

The annotations in the com.edorasware.api.annotation package provide additional context about how a particular API interface is intended to be used, for example whether a given interface is experimental or can be used to extend the functionality of edoras one.

Release version numbering

Our release version numbering scheme follows the guidelines for semantic versioning, namely:

Given a version number MAJOR.MINOR.PATCH, increment the:

MAJOR version when you make incompatible API changes,
MINOR version when you add functionality in a backwards-compatible manner, and
PATCH version when you make backwards-compatible bug fixes.

Deprecation policy

APIs that should no longer be used will be marked as deprecated using the standard Java annotations and the migration path to an alternative API documented where appropriate. New application code should not use deprecated APIs, and existing code should be migrated as soon as this is practical.

If an API has to be deprecated then it will normally be deprecated in a minor or patch release, and may be dropped completely when the next major version is released.