Skip navigation links
edoras one Java API (2.0.3)

edoras one Java API (2.0.3)

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

See: Description

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.models
Provides functionality related to Apps and models.
com.edorasware.api.persistence.internal  
com.edorasware.api.process
Provides functionality specific to process work objects.
com.edorasware.api.query
Work object query support.
com.edorasware.api.query.internal  
com.edorasware.api.rest
Interfaces related to the public REST API.
com.edorasware.api.time
Time and date support.
com.edorasware.api.util
Utility interfaces and classes.
com.edorasware.api.value
Work object value access.
com.edorasware.api.value.internal  
com.edorasware.api.web
Basic classes and values used by the web interface.
com.edorasware.api.workobject
Interfaces for work object access and manipulation.
com.edorasware.cloud.core  
com.edorasware.cloud.core.account  
com.edorasware.cloud.core.auditlog  
com.edorasware.cloud.core.bpmn  
com.edorasware.cloud.core.content  
com.edorasware.cloud.core.content.internal  
com.edorasware.cloud.core.conversion  
com.edorasware.cloud.core.conversion.internal  
com.edorasware.cloud.core.dataexport  
com.edorasware.cloud.core.dataexport.converter  
com.edorasware.cloud.core.deploy  
com.edorasware.cloud.core.diagram  
com.edorasware.cloud.core.expression  
com.edorasware.cloud.core.expression.activiti  
com.edorasware.cloud.core.expression.dmn  
com.edorasware.cloud.core.init  
com.edorasware.cloud.core.init.config  
com.edorasware.cloud.core.json  
com.edorasware.cloud.core.json.config  
com.edorasware.cloud.core.mail  
com.edorasware.cloud.core.migration  
com.edorasware.cloud.core.model  
com.edorasware.cloud.core.models  
com.edorasware.cloud.core.notification  
com.edorasware.cloud.core.patch.data  
com.edorasware.cloud.core.patch.transfer  
com.edorasware.cloud.core.provider  
com.edorasware.cloud.core.provider.account  
com.edorasware.cloud.core.provider.admin  
com.edorasware.cloud.core.provider.caze  
com.edorasware.cloud.core.provider.document  
com.edorasware.cloud.core.provider.group  
com.edorasware.cloud.core.provider.model  
com.edorasware.cloud.core.provider.query  
com.edorasware.cloud.core.provider.task  
com.edorasware.cloud.core.provider.tenant  
com.edorasware.cloud.core.provider.user  
com.edorasware.cloud.core.security  
com.edorasware.cloud.core.service  
com.edorasware.cloud.core.service.caze  
com.edorasware.cloud.core.service.configuration  
com.edorasware.cloud.core.service.content  
com.edorasware.cloud.core.service.document  
com.edorasware.cloud.core.service.document.pdf  
com.edorasware.cloud.core.service.document.word  
com.edorasware.cloud.core.service.frontendobject  
com.edorasware.cloud.core.service.frontendobject.internal  
com.edorasware.cloud.core.service.mail  
com.edorasware.cloud.core.service.model  
com.edorasware.cloud.core.service.process  
com.edorasware.cloud.core.service.rest  
com.edorasware.cloud.core.service.search  
com.edorasware.cloud.core.service.search.internal  
com.edorasware.cloud.core.service.statistic  
com.edorasware.cloud.core.service.task  
com.edorasware.cloud.core.service.tenant  
com.edorasware.cloud.core.service.user  
com.edorasware.cloud.core.state  
com.edorasware.cloud.core.template  
com.edorasware.cloud.core.template.flowable  
com.edorasware.cloud.core.template.simple  
com.edorasware.cloud.core.tenant  
com.edorasware.cloud.core.transfer  
com.edorasware.cloud.core.transfer.integration  
com.edorasware.cloud.core.transfer.internal  
com.edorasware.cloud.core.transfer.json  
com.edorasware.cloud.core.util  
com.edorasware.cloud.transfer  
com.edorasware.cmmn.engine.core
<p>CMMN engine core service interfaces and implementations.
com.edorasware.cmmn.engine.core.engineactions
<p>Action classes for all of the engine actions which alter engine state (an example of such an action would be handlePlanItemTransition which is implemented in PlanItemTransitionAction here.
com.edorasware.cmmn.engine.hooks
<p>CMMN engine implementation hooks.
com.edorasware.cmmn.engine.utility
<p>CMMN engine utility interfaces and classes.
com.edorasware.cmmn.model
<p>Implementation of a CMMN case engine based on the specification http://www.omg.org/spec/CMMN/1.0/ (referred to as <i>spec</i> in subsequent JavaDoc).
com.edorasware.cmmn.model.casefile
<p>CMMN CaseFile related code.
com.edorasware.cmmn.model.exceptions
<p>CMMN related exception classes.
com.edorasware.cmmn.model.expressions
<p>Contains helper classes for plan item and case file item wrapping and lookup.
com.edorasware.cmmn.model.persistence
<p>Contains classes and code related to the persistence of engine model state.
com.edorasware.cmmn.model.planning
<p>The planning of discretionary items are a relatively big topic within the CMMN spec.
com.edorasware.cmmn.model.rulesandsentries
<p>Contains classes and code related to the evaluation of rules, sentries (onParts) and the evaluation of applicability rules for discretionary items.
com.edorasware.cmmn.model.statesandactions
<p>A package containing code to represent a runtime model’s current states and available actions.
com.edorasware.cmmn.model.staticmodel
<p>Plan items and discretionary items in a design-time model are represented by instances of PlannableItem.
com.edorasware.cmmn.model.structure
<p>A very central package.
com.edorasware.cmmn.model.visitor
<p>The visitor (GOF) pattern is used in order to apply certain operations to the case model structure.
com.edorasware.cmmn.model.xml  
com.edorasware.cmmn.one
Contains packages and classes for the integration of the CMMN case engine with edoras-one.
com.edorasware.cmmn.one.casefileitemhandlers
<p>Contains code and classes implementing the CaseFileItemListeners interface.
com.edorasware.cmmn.one.edoraslisteners
<p>Contains code and classes to listen to edoras events (like, for example, the completion of an flowable process).
com.edorasware.cmmn.one.expressions
<p>Contains classes for plan item and case file item wrapping and lookup.
com.edorasware.cmmn.one.implementation
<p>CMMN engine implementation classes for edoras one.
com.edorasware.cmmn.one.service
The edoras one CMMN service implementation.
com.edorasware.cmmn.one.statesandactions  
com.edorasware.cmmn.one.timer  
com.edorasware.cmmn.one.transitionhandlers
<p>Contains code and classes implementing the TransitionListeners interface.
com.edorasware.cmmn.one.transitionhandlers.complete
<p>Contains code and classes implementing the edoras side of the CMMN state transition PlanItemTransition.COMPLETE.
com.edorasware.cmmn.one.transitionhandlers.create
<p>Contains code and classes implementing the edoras side of the CMMN state transition PlanItemTransition.CREATE.
com.edorasware.cmmn.one.transitionhandlers.disable
<p>Contains code and classes implementing the edoras side of the CMMN state transition PlanItemTransition.DISABLE.
com.edorasware.cmmn.one.transitionhandlers.enable
<p>Contains code and classes implementing the edoras side of the CMMN state transition PlanItemTransition.ENABLE.
com.edorasware.cmmn.one.transitionhandlers.exit
<p>Contains code and classes implementing the edoras side of the CMMN state transition PlanItemTransition.EXIT.
com.edorasware.cmmn.one.transitionhandlers.fault
<p>Contains code and classes implementing the edoras side of the CMMN state transition PlanItemTransition.FAULT.
com.edorasware.cmmn.one.transitionhandlers.manualStart
<p>Contains code and classes implementing the edoras side of the CMMN state transition PlanItemTransition.MANUAL_START.
com.edorasware.cmmn.one.transitionhandlers.occur
<p>Contains code and classes implementing the edoras side of the CMMN state transition PlanItemTransition.OCCUR.
com.edorasware.cmmn.one.transitionhandlers.parentComplete
<p>Contains code and classes implementing the edoras side of the CMMN state transition PlanItemTransition.PARENT_COMPLETE.
com.edorasware.cmmn.one.transitionhandlers.reactivate
<p>Contains code and classes implementing the edoras side of the CMMN state transition PlanItemTransition.REACTIVATE.
com.edorasware.cmmn.one.transitionhandlers.reenable
<p>Contains code and classes implementing the edoras side of the CMMN state transition PlanItemTransition.REENABLE.
com.edorasware.cmmn.one.transitionhandlers.start
<p>Contains code and classes implementing the edoras side of the CMMN state transition PlanItemTransition.START.
com.edorasware.cmmn.one.transitionhandlers.terminate
<p>Contains code and classes implementing the edoras side of the CMMN state transition PlanItemTransition.TERMINATE.
com.edorasware.commons.core.aggregate.internal.jdbc  
com.edorasware.commons.core.any
Classes for generic work object management.
com.edorasware.commons.core.any.internal  
com.edorasware.commons.core.any.internal.jdbc  
com.edorasware.commons.core.any.support
SPIs and APIs to integrate with generic work object management.
com.edorasware.commons.core.cache  
com.edorasware.commons.core.content
Classes related to content management.
com.edorasware.commons.core.content.internal  
com.edorasware.commons.core.content.internal.database  
com.edorasware.commons.core.content.internal.filesystem  
com.edorasware.commons.core.content.internal.memory  
com.edorasware.commons.core.content.internal.variable  
com.edorasware.commons.core.content.maintenance  
com.edorasware.commons.core.content.support
Support classes for content management.
com.edorasware.commons.core.content.support.database  
com.edorasware.commons.core.definition  
com.edorasware.commons.core.elastic  
com.edorasware.commons.core.entity
Classes to model business entities.
com.edorasware.commons.core.event  
com.edorasware.commons.core.field
Classes related to fields.
com.edorasware.commons.core.field.entity
Classes related to entity fields.
com.edorasware.commons.core.id
Classes involved in id handling.
com.edorasware.commons.core.identity
Classes for identity management.
com.edorasware.commons.core.identity.internal  
com.edorasware.commons.core.identity.support  
com.edorasware.commons.core.init  
com.edorasware.commons.core.license
Classes related to license handling.
com.edorasware.commons.core.maintenance  
com.edorasware.commons.core.maintenance.internal  
com.edorasware.commons.core.maintenance.internal.jdbc  
com.edorasware.commons.core.maintenance.support  
com.edorasware.commons.core.manager.entity
Classes related to entity managers.
com.edorasware.commons.core.modification.entity
Classes related to entity modifications.
com.edorasware.commons.core.persistence
Classes for database persistence management and configuration thereof.
com.edorasware.commons.core.persistence.entity  
com.edorasware.commons.core.persistence.entity.jdbc  
com.edorasware.commons.core.persistence.jdbc
Classes for JDBC-based database persistence management and configuration thereof.
com.edorasware.commons.core.persistence.schema  
com.edorasware.commons.core.persistence.schema.internal  
com.edorasware.commons.core.persistence.schema.support  
com.edorasware.commons.core.process  
com.edorasware.commons.core.property  
com.edorasware.commons.core.property.internal  
com.edorasware.commons.core.provider.entity
Classes related to entity providers.
com.edorasware.commons.core.query
Classes to build queries.
com.edorasware.commons.core.query.entity
Classes to build entity-specific queries.
com.edorasware.commons.core.service.entity
Classes related to entity services.
com.edorasware.commons.core.task  
com.edorasware.commons.core.time.internal  
com.edorasware.commons.core.util
edoras commons utility classes.
com.edorasware.commons.core.util.bulk  
com.edorasware.commons.core.util.bulk.internal  
com.edorasware.commons.core.util.collect
Collection utility classes.
com.edorasware.commons.core.util.concurrency
Concurrency utility classes.
com.edorasware.commons.core.util.db
Database utility classes.
com.edorasware.commons.core.util.fp
Functional programming utility classes.
com.edorasware.commons.core.util.generics
Generics utility classes.
com.edorasware.commons.core.util.guava
Guava utility classes.
com.edorasware.commons.core.util.io
I/O utility classes.
com.edorasware.commons.core.util.progress  
com.edorasware.commons.core.util.security
Security utility classes.
com.edorasware.commons.core.util.spring
Spring utility classes.
com.edorasware.commons.core.util.string
String utility classes.
com.edorasware.commons.core.util.xml
XML utility classes.
com.edorasware.commons.core.value  
com.edorasware.commons.core.version  
com.edorasware.config  
com.edorasware.config.action  
com.edorasware.config.content  
com.edorasware.config.engine  
com.edorasware.config.i18n  
com.edorasware.config.mail  
com.edorasware.config.persistence  
com.edorasware.config.property  
com.edorasware.config.security  
com.edorasware.config.util  
com.edorasware.gear.core.dmn.internal  
com.edorasware.gear.core.engine.config.flowable  
com.edorasware.gear.core.engine.support.activiti  
com.edorasware.gear.core.engine.support.flowable  
com.edorasware.gear.core.engine.support.flowable.dmn  
com.edorasware.gear.core.event  
com.edorasware.gear.core.event.internal  
com.edorasware.gear.core.expression  
com.edorasware.gear.core.process  
com.edorasware.gear.core.process.internal  
com.edorasware.gear.core.process.support  
com.edorasware.gear.core.security  
com.edorasware.gear.core.task.internal  
com.edorasware.gear.core.task.support  
com.edorasware.gear.core.workobject  
com.edorasware.gear.core.workobject.internal  
com.edorasware.one.action  
com.edorasware.one.action.internal  
com.edorasware.one.addon  
com.edorasware.one.addon.internal  
com.edorasware.one.app  
com.edorasware.one.app.datamodel  
com.edorasware.one.app.graph  
com.edorasware.one.app.internal  
com.edorasware.one.app.migration  
com.edorasware.one.app.migration.internal  
com.edorasware.one.cache.internal  
com.edorasware.one.cache.internal.redis  
com.edorasware.one.caze  
com.edorasware.one.caze.internal  
com.edorasware.one.cmmn  
com.edorasware.one.cmmn.internal  
com.edorasware.one.configuration  
com.edorasware.one.configuration.internal  
com.edorasware.one.content  
com.edorasware.one.converter  
com.edorasware.one.datacheck  
com.edorasware.one.datacheck.internal  
com.edorasware.one.definition  
com.edorasware.one.definition.internal  
com.edorasware.one.dmn  
com.edorasware.one.dmn.internal  
com.edorasware.one.document  
com.edorasware.one.document.internal  
com.edorasware.one.document.viewer  
com.edorasware.one.document.viewer.internal  
com.edorasware.one.elastic  
com.edorasware.one.entitytemplate  
com.edorasware.one.entitytemplate.internal  
com.edorasware.one.filestorage  
com.edorasware.one.filestorage.internal  
com.edorasware.one.form  
com.edorasware.one.form.internal  
com.edorasware.one.frontendobject  
com.edorasware.one.frontendobject.internal  
com.edorasware.one.i18n  
com.edorasware.one.i18n.internal  
com.edorasware.one.identity  
com.edorasware.one.identity.group  
com.edorasware.one.identity.group.internal  
com.edorasware.one.identity.internal  
com.edorasware.one.identity.user  
com.edorasware.one.identity.user.internal  
com.edorasware.one.init  
com.edorasware.one.legacy  
com.edorasware.one.maintenance  
com.edorasware.one.maintenance.internal  
com.edorasware.one.model  
com.edorasware.one.model.internal  
com.edorasware.one.modeler  
com.edorasware.one.modeler.internal  
com.edorasware.one.navigation  
com.edorasware.one.navigation.internal  
com.edorasware.one.navigation.internal.json  
com.edorasware.one.permission.dashboard  
com.edorasware.one.permission.dashboard.internal  
com.edorasware.one.permission.view  
com.edorasware.one.permission.view.internal  
com.edorasware.one.preview  
com.edorasware.one.preview.internal  
com.edorasware.one.rest.manager  
com.edorasware.one.rest.manager.internal  
com.edorasware.one.search  
com.edorasware.one.search.internal  
com.edorasware.one.security  
com.edorasware.one.servlet  
com.edorasware.one.statistic  
com.edorasware.one.statistic.internal  
com.edorasware.one.tenant  
com.edorasware.one.tenant.internal  
com.edorasware.one.thumbnail  
com.edorasware.one.thumbnail.internal  
com.edorasware.one.upgrade  
com.edorasware.one.upload  
com.edorasware.one.upload.internal  
com.edorasware.one.util  
com.edorasware.one.util.dashboard  
com.edorasware.one.util.execution  
com.edorasware.one.workitem  
com.edorasware.one.workitem.internal  
com.edorasware.one.workitem.internal.json  
com.edorasware.one.workitem.model  
com.edorasware.publicapi  
com.edorasware.publicapi.rest  
com.edorasware.publicapi.rest.swagger  
com.edorasware.rest  
com.edorasware.rest.action  
com.edorasware.rest.app  
com.edorasware.rest.cmmn  
com.edorasware.rest.configuration  
com.edorasware.rest.dmn  
com.edorasware.rest.document  
com.edorasware.rest.document.viewer  
com.edorasware.rest.entitytemplate  
com.edorasware.rest.filestorage  
com.edorasware.rest.forms  
com.edorasware.rest.frontendobject  
com.edorasware.rest.i18n  
com.edorasware.rest.maintenance  
com.edorasware.rest.modeler  
com.edorasware.rest.navigation  
com.edorasware.rest.permission.dashboard  
com.edorasware.rest.permission.view  
com.edorasware.rest.preview  
com.edorasware.rest.search  
com.edorasware.rest.statistic  
com.edorasware.rest.user  
com.edorasware.rest.widgets  
com.edorasware.rest.workitem  
org.flywaydb.core  
org.flywaydb.core.internal.resolver.spring  

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.

Skip navigation links
edoras one Java API (2.0.3)

Copyright © 2010 - 2018 edorasware ag. All Rights Reserved.