org.imixs.workflow.jee.ejb
Interface ModelService

All Superinterfaces:

org.imixs.workflow.ExtendedModel, org.imixs.workflow.Model

All Known Subinterfaces:

ModelServiceRemote

public interface ModelService
extends org.imixs.workflow.ExtendedModel

The ModelManager is the JEE Implementation of the IX Workflow API Interface org.imixs.workflow.Model. The Interface acts as a Service Facade and extends the standard interface with methods to store model informations. The ModelManager is independend form the IX JEE Entity EJBs and uses the standard IntemCollection Object as a data transfer object to comunitcate with clients. Find Details: https://ix-workflow.dev.java.net/ https://www.imixs.org

Author:

rsoika

See Also:

Model

Method Summary

Collection<org.imixs.workflow.ItemCollection>	getActivityEntityListByVersion(int aProcessID, String aModelVersion) returns the ActivityList for a specific model version
List<String>	getAllModelVersions() returns a String list of all accessible Modelversions
List<org.imixs.workflow.ItemCollection>	getAllProcessEntitiesByGroup(String aGroup) returns a list of all ProcessEntities for a specific ProcessGroup
List<org.imixs.workflow.ItemCollection>	getAllStartProcessEntities() returns a list of all ProcessEntities which are the first one in each ProcessGroup.
List<org.imixs.workflow.ItemCollection>	getAllStartProcessEntitiesByVersion(String version)
List<String>	getAllWorkflowGroups() returns a String list of all existing ProcessGroup Names
List<String>	getAllWorkflowGroupsByVersion(String version)
Collection<org.imixs.workflow.ItemCollection>	getEnvironmentEntityList() returns the EnvironmentList
Collection<org.imixs.workflow.ItemCollection>	getEnvironmentEntityListByVersion(String aModelVersion) returns the EnvironmentList for a specific model version
String	getLatestVersion()
Collection<org.imixs.workflow.ItemCollection>	getProcessEntityListByVersion(String aModelVersion) returns the processList for a specific model version
List<org.imixs.workflow.ItemCollection>	getPublicActivities(int aprocessid) returns all the activities in a list for a corresponding process entity The method returns only Activities where keypublicresult !
List<org.imixs.workflow.ItemCollection>	getPublicActivitiesByVersion(int aprocessid, String version)
void	removeModelVersion(String aModelVersion) This method removes an existing model with the corresponding modelversion
void	saveActivityEntity(org.imixs.workflow.ItemCollection ic) Saves or updates an ActivityEntity represented by an ItemCollection.
void	saveEnvironmentEntity(org.imixs.workflow.ItemCollection ic) Saves or updates an EnvironmentEntity represented by an ItemCollection.
void	saveProcessEntity(org.imixs.workflow.ItemCollection ic) Saves or updates a ProcessEntitiy represented by an ItemCollection.

Methods inherited from interface org.imixs.workflow.ExtendedModel

getActivityEntityByVersion, getProcessEntityByVersion

Methods inherited from interface org.imixs.workflow.Model

getActivityEntity, getActivityEntityList, getProcessEntity, getProcessEntityList

Method Detail

saveProcessEntity

void saveProcessEntity(org.imixs.workflow.ItemCollection ic)
                       throws Exception

Saves or updates a ProcessEntitiy represented by an ItemCollection. The Entity is unique identified of its Attributes 'numProcessID' and '$modelversion' The Method verifies that an existing instance will be updated.

Parameters:

ic -

Throws:

Exception

saveActivityEntity

void saveActivityEntity(org.imixs.workflow.ItemCollection ic)
                        throws Exception

Saves or updates an ActivityEntity represented by an ItemCollection. The Entity is unique identified of its Attributes 'numProcessID', 'numActivityID' and '$modelversion' The Method verifies that an existing instance will be updated.

Parameters:

ic -

Throws:

Exception

saveEnvironmentEntity

void saveEnvironmentEntity(org.imixs.workflow.ItemCollection ic)
                           throws Exception

Saves or updates an EnvironmentEntity represented by an ItemCollection. The Entity is unique identified of its Attributes 'txtName' and '$modelversion' The Method verifies that an existing instance will be updated.

Parameters:

ic -

Throws:

Exception

getProcessEntityListByVersion

Collection<org.imixs.workflow.ItemCollection> getProcessEntityListByVersion(String aModelVersion)
                                                                            throws Exception

returns the processList for a specific model version

Specified by:

getProcessEntityListByVersion in interface org.imixs.workflow.ExtendedModel

Parameters:

aModelVersion -

Returns:

Throws:

Exception

getActivityEntityListByVersion

Collection<org.imixs.workflow.ItemCollection> getActivityEntityListByVersion(int aProcessID,
                                                                             String aModelVersion)
                                                                             throws Exception

returns the ActivityList for a specific model version

Specified by:

getActivityEntityListByVersion in interface org.imixs.workflow.ExtendedModel

Parameters:

aProcessID -

aModelVersion -

Returns:

Throws:

Exception

getEnvironmentEntityList

Collection<org.imixs.workflow.ItemCollection> getEnvironmentEntityList()
                                                                       throws Exception

returns the EnvironmentList

Parameters:

aModelVersion -

Returns:

Throws:

Exception

getEnvironmentEntityListByVersion

Collection<org.imixs.workflow.ItemCollection> getEnvironmentEntityListByVersion(String aModelVersion)
                                                                                throws Exception

returns the EnvironmentList for a specific model version

Parameters:

aModelVersion -

Returns:

Throws:

Exception

removeModelVersion

void removeModelVersion(String aModelVersion)
                        throws Exception

This method removes an existing model with the corresponding modelversion

Parameters:

aModelVersion -

Throws:

Exception

getLatestVersion

String getLatestVersion()
                        throws Exception

Throws:

Exception

getAllModelVersions

List<String> getAllModelVersions()
                                 throws Exception

returns a String list of all accessible Modelversions

Returns:

Throws:

Exception

getPublicActivities

List<org.imixs.workflow.ItemCollection> getPublicActivities(int aprocessid)

returns all the activities in a list for a corresponding process entity The method returns only Activities where keypublicresult != "0"

Returns:

List of activity Entities

getPublicActivitiesByVersion

List<org.imixs.workflow.ItemCollection> getPublicActivitiesByVersion(int aprocessid,
                                                                     String version)

getAllWorkflowGroups

List<String> getAllWorkflowGroups()

returns a String list of all existing ProcessGroup Names

Returns:

getAllWorkflowGroupsByVersion

List<String> getAllWorkflowGroupsByVersion(String version)

getAllStartProcessEntities

List<org.imixs.workflow.ItemCollection> getAllStartProcessEntities()

returns a list of all ProcessEntities which are the first one in each ProcessGroup. So for each ProcessGroup the ProcessEntity with the lowest processID will be returned.

Returns:

getAllStartProcessEntitiesByVersion

List<org.imixs.workflow.ItemCollection> getAllStartProcessEntitiesByVersion(String version)

getAllProcessEntitiesByGroup

List<org.imixs.workflow.ItemCollection> getAllProcessEntitiesByGroup(String aGroup)

returns a list of all ProcessEntities for a specific ProcessGroup

Returns: