-
Interface Summary Interface Description Activity The activity is a pluggable component associated to a node.ChangeableInstance An instance which provides all necessary change primitives for modifications on instance level.ChangeableTemplate ChangePrimitives The ProcessChangePrimitive interface provides all basic functions for changing a process (template or instance).DataEdge There may be only one data edge connecting a data element and a node per direction.DataElement The DataElement interface offers access to the data elements of a process.DecisionActivity Represents an activity which is used for decisions in the process model.DecisionStatement Holds all information associated with a decision IDDeltaLayer A meta interface for the TemplateDeltaLayer and the InstanceDeltaLayer.EBPInstanceReference This interface provides a reference to an instance of an executable business process (EBP) or rather to the corresponding container.Edge The interface for edges, used to model the controlflow (control-, loop- and sync-edges).EmbeddedProcess TheEmbeddedProcessis used to embed another process template.ExecutableBusinessProcess TheExecutableBusinessProcess(EBP) defines a common interface for objects which can be plugged to nodes of a process.Instance The Instance interface is used to represent process instances.InstanceDeltaLayer InstanceHistories The InstanceHistories interface provides getters for various histories as XML document.InstanceReference The lightweight representation of a process instance.InstanceStatus The instance status interface provides access to all instance specific status information.LightWeightProcess TheLightWeightProcess(LWP) is used as a stand-in for sub-processes.Node The Node interface is used to represent the nodes of the control flow.ProcessModelFactory The factory of the processmodel is used to create new objects.ProcessModelFactory.StructuralNodeData Structural node data.ProcessModelParameter The Parameter interface describes the connectors on the executable business process side (activity/sub-process).ProcessType Process types organise various process templates logically and provide the means to manage versions of templates.ReferencedProcess TheReferencedProcessis used to reference another process template.StructuredDataEdge A data edge with structural information.StructuredEdge An edge with structural information.Template The Template interface represents process templates.TemplateDeltaLayer TODO Methods may change - document and implement later.TemplateProxy The lightweight representation of a process template for usage in the process repository.TemplateReference The lightweight representation of a process template.TemplateStatus The TemplateStatus provides access to the state of a template.VariableParallelismEBP Variable parallelism resembles aforeachwhich iterates through all elements of a list but parallel instead of one after the other. -
Class Summary Class Description AbstractWrappingTemplate Abstract implementation for wrapping a template object.ChangeReport AChangeReportprovides aCheckReporttogether with the old and the new ID of the instance and the new changeable instance object.DataElementComparator This comparator can be used to compare DataElements.IDWrappingTemplate This class wraps an embedded template, so thatTemplate.getID()returns the ID of the embedded process instead of the ID the original template had.LocalisedChangeReport AChangeReportproviding localisation like aLocalisedCheckReport.NodeComparator This comparator can be used to compare Nodes.StructuredDataEdgeComparator This comparator can be used to compare StructuredDataEdges.StructuredEdgeComparator This comparator can be used to compare StructuredEdges. -
Exception Summary Exception Description InvalidInstanceStateException This exception will be raised if a process instance is not in the right state to perform a desired action.InvalidTemplateStateException This exception will be raised if a process template is not in the right state to perform a desired method.
Package de.aristaflow.adept2.model.processmodel Description
Warning: This package description is OUTDATED (work in progress)!!
The ADEPT2 data model provides easy to use access to all process related data.
The ADEPT2 data model provides easy to use access to all process related data.
Overview
The processmodel covers all elements and relations used in a process.General design backgrounds
The process model enforces a strict separation of responsibilities. This also enforces strict separation of e.g. structural and non-structural data as well as template and instance data. Concerning object references, the model is strictly hierarchical: There are only references to child entities, never to entities with parent or sibling relation. The template has e.g. references to the nodes and edges, but neither nodes nor edges have a reference to the template or to each other.The elements of a process template
Nodes
Edges
Application Integration
The Executable Business Process
TODO old - reviewThe template with nodes, edges, data edges and data elements just builds the control and data flow. The connection to executable components is done using the interface ExecutableBusinessProcess (EBP). An EBP is either an Activity or a subprocess (LightWeightProcess). In the context of a process- or activity-repository, an activity or light-weight process are "instances" of the object in the repository. The activity-repository keeps a registry of all known activities in form of activity-templates. As soon as the user in the process template editor, e.g. takes an activity-template, drags it onto the process and drops it over a node, the activity-template is instantiated as "Activity", as it is known within the processmodel.
Connectors
- connector are the cut between the template's structure (in this case: the data flow), and the integration of the parameters of EBPs
- how a data element is connected to an EBP's parameter: data element is connected to the node via a data edge, in the scope of the template structure this connection is fixed to a connector (and so within Template => Template#getConnector and Template#getDataElement(int,int)). In the scope of the node, there is a mapping between connectors and parameter names. This prohibites a direct connection between a parameter and a data element (e.g. by an data element ID or object reference).
Process instances
- The interface Instance covers all instance related data
- => ExecutableInstance: methods for changing states, interface for internal use in the execution manager
- values for data elements are not part of the process model, they must be retrieved using the data manager
- changeable instance: API with change primitives, methods should only be used by change operations => see "Changing process templates"
- the structural data is stored in the template only. => Instance#getTemplate()
- in case of an ad-hoc modified instance: Instance#getTemplate() returns a delta layer (for most API users not of interest)
Changing process templates and instances
- Changes must be done using change operations.
- Changeable template and changeable instance implement the required change primitives.
- the change primitives are meant for change operation internal use only!! they must not be used in a different context!! => for most API users not of interest!