org.imixs.workflow.engine

Class ModelService

java.lang.Object

org.imixs.workflow.engine.ModelService

All Implemented Interfaces:

ModelManager

@DeclareRoles(value={"org.imixs.ACCESSLEVEL.NOACCESS","org.imixs.ACCESSLEVEL.READERACCESS","org.imixs.ACCESSLEVEL.AUTHORACCESS","org.imixs.ACCESSLEVEL.EDITORACCESS","org.imixs.ACCESSLEVEL.MANAGERACCESS"})
 @RolesAllowed(value={"org.imixs.ACCESSLEVEL.NOACCESS","org.imixs.ACCESSLEVEL.READERACCESS","org.imixs.ACCESSLEVEL.AUTHORACCESS","org.imixs.ACCESSLEVEL.EDITORACCESS","org.imixs.ACCESSLEVEL.MANAGERACCESS"})
public class ModelService
extends Object
implements ModelManager

The ModelManager is independent form the IX JEE Entity EJBs and uses the standard IntemCollection Object as a data transfer object to communicate with clients. Since Version 1.7.0 The Implementation handles multiple model versions. Different Versions of an Model Entity can be saved and updated. The Getter methods can be furthermore Controlled by providing a valid Model Version. If no model version is set this Implementation automatically defaults to the highest available ModelVersion

Author:

rsoika

See Also:

ModelManager, jee.ejb.ModelManager

Constructor Summary

Constructors

Constructor and Description
ModelService()

Method Summary

Modifier and Type	Method and Description
void	addModel(Model model) This Method adds a model into the internal model store.
void	deleteModel(String version) This method deletes an existing Model from the database and removes the model form the internal ModelStore.
List<String>	findVersionsByGroup(String group) This method returns a sorted list of model versions containing the requested workflow group.
String	getDataObject(ItemCollection bpmnElement, String name) Returns a BPMN DataObject, part of a Task or Event element, by its name DataObjects can be associated in a BPMN Diagram with a Task or an Event element
Model	getModel(String version) Returns a Model by version.
Model	getModelByWorkitem(ItemCollection workitem) Returns a Model matching a given workitem.
List<String>	getVersions() returns a sorted String list of all stored model versions
ItemCollection	loadModelEntity(String version) This method loads an existing Model Entities from the database.
void	removeModel(String modelversion) This method removes a specific ModelVersion form the internal model store.
void	saveModel(BPMNModel model) This method saves a BPMNModel into the database and adds the model into the internal model store.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModelService

public ModelService()

Method Detail

addModel

public void addModel(Model model)
              throws ModelException

This Method adds a model into the internal model store. The model will not be saved in the database! Use saveModel to store the model permanently.

Specified by:

addModel in interface ModelManager

Throws:

ModelException

removeModel

public void removeModel(String modelversion)

This method removes a specific ModelVersion form the internal model store. If modelVersion is null the method will remove all models. The model will not be removed from the database. Use deleteModel to delete the model from the database.

Specified by:

removeModel in interface ModelManager

Throws:

AccessDeniedException

getModel

public Model getModel(String version)
               throws ModelException

Returns a Model by version. In case no matching model version exits, the method throws a ModelException.

Specified by:

getModel in interface ModelManager

Throws:

ModelException

getModelByWorkitem

public Model getModelByWorkitem(ItemCollection workitem)
                         throws ModelException

Returns a Model matching a given workitem. In case not matching model version exits, the method returns the highest Model Version matching the corresponding workflow group. The method throws a ModelException in case the model version did not exits.

Specified by:

getModelByWorkitem in interface ModelManager

Throws:

ModelException

getVersions

public List<String> getVersions()

returns a sorted String list of all stored model versions

Returns:

findVersionsByGroup

public List<String> findVersionsByGroup(String group)

This method returns a sorted list of model versions containing the requested workflow group. The result is sorted in reverse order, so the highest version number is the first in the result list.

Parameters:

group -

Returns:

saveModel

public void saveModel(BPMNModel model)
               throws ModelException

This method saves a BPMNModel into the database and adds the model into the internal model store.

If a model with the same model version exists in the database the old version will be deleted form the database first.

Parameters:

model -

Throws:

ModelException

deleteModel

public void deleteModel(String version)

This method deletes an existing Model from the database and removes the model form the internal ModelStore.

A model entity is identified by the type='model' and its name (model version). After the model entity was deleted form the database, the method will also remove the model from the ModelManager

Parameters:

model -

loadModelEntity

public ItemCollection loadModelEntity(String version)

This method loads an existing Model Entities from the database. A model entity is identified by its name (model version).

Parameters:

model -

getDataObject

public String getDataObject(ItemCollection bpmnElement,
                            String name)

Returns a BPMN DataObject, part of a Task or Event element, by its name

DataObjects can be associated in a BPMN Diagram with a Task or an Event element

Parameters:

bpmnElement -

Returns: