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
 java.util.Collection<org.imixs.workflow.ItemCollection> getActivityEntityListByVersion(int aProcessID, java.lang.String aModelVersion)
          returns the ActivityList for a specific model version
 java.util.List<java.lang.String> getAllModelVersions()
          returns a String list of all accessible Modelversions
 java.util.List<org.imixs.workflow.ItemCollection> getAllProcessEntitiesByGroup(java.lang.String aGroup)
          returns a list of all ProcessEntities for a specific ProcessGroup
 java.util.List<org.imixs.workflow.ItemCollection> getAllStartProcessEntities()
          returns a list of all ProcessEntities which are the first one in each ProcessGroup.
 java.util.List<org.imixs.workflow.ItemCollection> getAllStartProcessEntitiesByVersion(java.lang.String version)
           
 java.util.List<java.lang.String> getAllWorkflowGroups()
          returns a String list of all existing ProcessGroup Names
 java.util.List<java.lang.String> getAllWorkflowGroupsByVersion(java.lang.String version)
           
 java.util.Collection<org.imixs.workflow.ItemCollection> getEnvironmentEntityList()
          returns the EnvironmentList
 java.util.Collection<org.imixs.workflow.ItemCollection> getEnvironmentEntityListByVersion(java.lang.String aModelVersion)
          returns the EnvironmentList for a specific model version
 java.lang.String getLatestVersion()
           
 java.util.Collection<org.imixs.workflow.ItemCollection> getProcessEntityListByVersion(java.lang.String aModelVersion)
          returns the processList for a specific model version
 java.util.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 !
 java.util.List<org.imixs.workflow.ItemCollection> getPublicActivitiesByVersion(int aprocessid, java.lang.String version)
           
 void removeModelVersion(java.lang.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 java.lang.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:
java.lang.Exception

saveActivityEntity

void saveActivityEntity(org.imixs.workflow.ItemCollection ic)
                        throws java.lang.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:
java.lang.Exception

saveEnvironmentEntity

void saveEnvironmentEntity(org.imixs.workflow.ItemCollection ic)
                           throws java.lang.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:
java.lang.Exception

getProcessEntityListByVersion

java.util.Collection<org.imixs.workflow.ItemCollection> getProcessEntityListByVersion(java.lang.String aModelVersion)
                                                                                      throws java.lang.Exception
returns the processList for a specific model version

Specified by:
getProcessEntityListByVersion in interface org.imixs.workflow.ExtendedModel
Parameters:
aModelVersion -
Returns:
Throws:
java.lang.Exception

getActivityEntityListByVersion

java.util.Collection<org.imixs.workflow.ItemCollection> getActivityEntityListByVersion(int aProcessID,
                                                                                       java.lang.String aModelVersion)
                                                                                       throws java.lang.Exception
returns the ActivityList for a specific model version

Specified by:
getActivityEntityListByVersion in interface org.imixs.workflow.ExtendedModel
Parameters:
aProcessID -
aModelVersion -
Returns:
Throws:
java.lang.Exception

getEnvironmentEntityList

java.util.Collection<org.imixs.workflow.ItemCollection> getEnvironmentEntityList()
                                                                                 throws java.lang.Exception
returns the EnvironmentList

Parameters:
aModelVersion -
Returns:
Throws:
java.lang.Exception

getEnvironmentEntityListByVersion

java.util.Collection<org.imixs.workflow.ItemCollection> getEnvironmentEntityListByVersion(java.lang.String aModelVersion)
                                                                                          throws java.lang.Exception
returns the EnvironmentList for a specific model version

Parameters:
aModelVersion -
Returns:
Throws:
java.lang.Exception

removeModelVersion

void removeModelVersion(java.lang.String aModelVersion)
                        throws java.lang.Exception
This method removes an existing model with the corresponding modelversion

Parameters:
aModelVersion -
Throws:
java.lang.Exception

getLatestVersion

java.lang.String getLatestVersion()
                                  throws java.lang.Exception
Throws:
java.lang.Exception

getAllModelVersions

java.util.List<java.lang.String> getAllModelVersions()
                                                     throws java.lang.Exception
returns a String list of all accessible Modelversions

Returns:
Throws:
java.lang.Exception

getPublicActivities

java.util.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

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

getAllWorkflowGroups

java.util.List<java.lang.String> getAllWorkflowGroups()
returns a String list of all existing ProcessGroup Names

Returns:

getAllWorkflowGroupsByVersion

java.util.List<java.lang.String> getAllWorkflowGroupsByVersion(java.lang.String version)

getAllStartProcessEntities

java.util.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

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

getAllProcessEntitiesByGroup

java.util.List<org.imixs.workflow.ItemCollection> getAllProcessEntitiesByGroup(java.lang.String aGroup)
returns a list of all ProcessEntities for a specific ProcessGroup

Returns:


Copyright © 2006-2010 Imixs Software Solutions GmbH. All Rights Reserved.