org.imixs.workflow.jee.ejb
Interface ModelServiceRemote

All Known Implementing Classes:

ModelService

public interface ModelServiceRemote

The Remote interface for the ModelService EJB. Can be used by standalone java clients.

Author:

rsoika

See Also:

ModelService

Method Summary

org.imixs.workflow.ItemCollection	getActivityEntity(int processid, int activityid) This method returns the ActivityEntity with the highest Version number ($modelversion)
org.imixs.workflow.ItemCollection	getActivityEntityByVersion(int processid, int activityid, java.lang.String modelVersion)
java.util.Collection<org.imixs.workflow.ItemCollection>	getActivityEntityList(int processid) returns a collection of ItemCollections representing the model activity Entities for the coresponding processid
java.util.Collection<org.imixs.workflow.ItemCollection>	getActivityEntityListByVersion(int processid, java.lang.String aModelVersion)
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 independent from the modelversion.
java.util.List<org.imixs.workflow.ItemCollection>	getAllProcessEntitiesByGroupByVersion(java.lang.String aGroup, java.lang.String aversion) returns a list of all ProcessEntities for a specific ProcessGroup and modelversion.
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) returns a list of all ProcessEntities which are the first one in each ProcessGroup.
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()
java.util.Collection<org.imixs.workflow.ItemCollection>	getEnvironmentEntityListByVersion(java.lang.String modelversion)
java.lang.String	getLatestVersion() This helper method finds the highest Model Version available in the system.
org.imixs.workflow.ItemCollection	getProcessEntity(int processid)
org.imixs.workflow.ItemCollection	getProcessEntityByVersion(int processid, java.lang.String modelversion)
java.util.Collection<org.imixs.workflow.ItemCollection>	getProcessEntityList() returns a collection of ItemCollections representing the model process Entities
java.util.Collection<org.imixs.workflow.ItemCollection>	getProcessEntityListByVersion(java.lang.String aModelVersion) returns a collection of ItemCollections representing the model process Entities
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) returns all the activities in a list for a corresponding process entity The method returns only Activities where keypublicresult !
void	importModel(java.io.InputStream input) This method imports a workflow model file
void	removeModelVersion(java.lang.String modelversion) This method removes a spcific ModelVersion defined by param '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.

Method Detail

getActivityEntity

org.imixs.workflow.ItemCollection getActivityEntity(int processid,
                                                    int activityid)
                                                    throws org.imixs.workflow.exceptions.ModelException

This method returns the ActivityEntity with the highest Version number ($modelversion)

Throws:

org.imixs.workflow.exceptions.ModelException

getActivityEntityByVersion

org.imixs.workflow.ItemCollection getActivityEntityByVersion(int processid,
                                                             int activityid,
                                                             java.lang.String modelVersion)
                                                             throws org.imixs.workflow.exceptions.ModelException

Throws:

org.imixs.workflow.exceptions.ModelException

getProcessEntity

org.imixs.workflow.ItemCollection getProcessEntity(int processid)
                                                   throws org.imixs.workflow.exceptions.ModelException

Throws:

org.imixs.workflow.exceptions.ModelException

getProcessEntityByVersion

org.imixs.workflow.ItemCollection getProcessEntityByVersion(int processid,
                                                            java.lang.String modelversion)
                                                            throws org.imixs.workflow.exceptions.ModelException

Throws:

org.imixs.workflow.exceptions.ModelException

getActivityEntityList

java.util.Collection<org.imixs.workflow.ItemCollection> getActivityEntityList(int processid)
                                                                              throws org.imixs.workflow.exceptions.ModelException

returns a collection of ItemCollections representing the model activity Entities for the coresponding processid

Throws:

org.imixs.workflow.exceptions.ModelException

getActivityEntityListByVersion

java.util.Collection<org.imixs.workflow.ItemCollection> getActivityEntityListByVersion(int processid,
                                                                                       java.lang.String aModelVersion)
                                                                                       throws org.imixs.workflow.exceptions.ModelException

Throws:

org.imixs.workflow.exceptions.ModelException

getProcessEntityList

java.util.Collection<org.imixs.workflow.ItemCollection> getProcessEntityList()
                                                                             throws org.imixs.workflow.exceptions.ModelException

returns a collection of ItemCollections representing the model process Entities

Throws:

org.imixs.workflow.exceptions.ModelException

getProcessEntityListByVersion

java.util.Collection<org.imixs.workflow.ItemCollection> getProcessEntityListByVersion(java.lang.String aModelVersion)
                                                                                      throws org.imixs.workflow.exceptions.ModelException

returns a collection of ItemCollections representing the model process Entities

Throws:

org.imixs.workflow.exceptions.ModelException

getEnvironmentEntityList

java.util.Collection<org.imixs.workflow.ItemCollection> getEnvironmentEntityList()
                                                                                 throws org.imixs.workflow.exceptions.ModelException

Throws:

org.imixs.workflow.exceptions.ModelException

getEnvironmentEntityListByVersion

java.util.Collection<org.imixs.workflow.ItemCollection> getEnvironmentEntityListByVersion(java.lang.String modelversion)
                                                                                          throws org.imixs.workflow.exceptions.ModelException

Throws:

org.imixs.workflow.exceptions.ModelException

saveActivityEntity

void saveActivityEntity(org.imixs.workflow.ItemCollection ic)
                        throws org.imixs.workflow.exceptions.ModelException,
                               org.imixs.workflow.exceptions.AccessDeniedException

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:

org.imixs.workflow.exceptions.AccessDeniedException

java.lang.Exception

org.imixs.workflow.exceptions.ModelException

saveProcessEntity

void saveProcessEntity(org.imixs.workflow.ItemCollection ic)
                       throws org.imixs.workflow.exceptions.ModelException,
                              org.imixs.workflow.exceptions.AccessDeniedException

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:

org.imixs.workflow.exceptions.AccessDeniedException

org.imixs.workflow.exceptions.ModelException

saveEnvironmentEntity

void saveEnvironmentEntity(org.imixs.workflow.ItemCollection ic)
                           throws org.imixs.workflow.exceptions.ModelException,
                                  org.imixs.workflow.exceptions.AccessDeniedException

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:

org.imixs.workflow.exceptions.AccessDeniedException

java.lang.Exception

org.imixs.workflow.exceptions.ModelException

removeModelVersion

void removeModelVersion(java.lang.String modelversion)
                        throws org.imixs.workflow.exceptions.ModelException,
                               org.imixs.workflow.exceptions.AccessDeniedException

This method removes a spcific ModelVersion defined by param 'modelversion'. If modelVersion is null the method will remove all models

Throws:

org.imixs.workflow.exceptions.AccessDeniedException

org.imixs.workflow.exceptions.ModelException

getLatestVersion

java.lang.String getLatestVersion()
                                  throws org.imixs.workflow.exceptions.ModelException

This helper method finds the highest Model Version available in the system. Returns an empty String if no version was found!

Returns:

String with the latest model version

Throws:

org.imixs.workflow.exceptions.ModelException

getAllModelVersions

java.util.List<java.lang.String> getAllModelVersions()

returns a String list of all accessible Modelversions

Returns:

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)

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

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. The method builds a cash with the best (lowest) ProcessID for each process group.

Returns:

getAllStartProcessEntitiesByVersion

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

returns a list of all ProcessEntities which are the first one in each ProcessGroup. The ModelVersion specifies the Model to be analiezed. So for each ProcessGroup the ProcessEntity with the lowest processID will be returned. The method builds a cash with the best (lowest) ProcessID for each process group. The collection returned will be sorted by the numProcessID

Returns:

getAllProcessEntitiesByGroup

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

returns a list of all ProcessEntities for a specific ProcessGroup independent from the modelversion. The same workflowGroup contained in to different model versions will be returned twice.

Returns:

getAllProcessEntitiesByGroupByVersion

java.util.List<org.imixs.workflow.ItemCollection> getAllProcessEntitiesByGroupByVersion(java.lang.String aGroup,
                                                                                        java.lang.String aversion)

returns a list of all ProcessEntities for a specific ProcessGroup and modelversion.

Parameters:

aGroup -

aversion -

Returns:

importModel

void importModel(java.io.InputStream input)
                 throws org.imixs.workflow.exceptions.ModelException,
                        org.imixs.workflow.exceptions.AccessDeniedException

This method imports a workflow model file

Throws:

org.imixs.workflow.exceptions.ModelException

org.imixs.workflow.exceptions.AccessDeniedException