de.aristaflow.adept2.core.processrepository

Interface ProcessRepository

All Superinterfaces:

ADEPT2Service

public interface ProcessRepository
extends ADEPT2Service

The process repository is used to manage and browse process templates, the corresponding changes and process types (trees of process templates) as well as searching of process and activity templates. It also allows to access further management functions of the process repository, for example process template, data type and template state management.

Process templates are classified by process types (for instance, a process type "customer order"). Every process type consists of a tree of process templates. The tree structure represents the relation between different process templates. For every process template a change history as well as a structural representation of the changes is stored, which is needed for schema evolution.

Since the complete evolution of a process type is maintained, the change histories/structural changes do not need to be complete. Instead, they contain only the differences to the corresponding parent template. For the root template of a process type the complete history is stored, hence the implicit "parent" of the root template is the null template (a template with just a start and an end node).

Besides the template itself and the change history metadata is maintained. The template includes the unique (with respect to a process repository) ID, the name, the creator of the template and the creation time. This data is provided in retrieval methods which do not load a complete template since it suffices for finding and selecting a process template.

Author:

Ulrich Kreher

Method Summary

Modifier and Type	Method and Description
ProcessType	createProcessType(SessionToken session, java.lang.String newProcessType) Creates a new process type with the designated name, stores the liable user and creates the root template, which is just a copy of the implicit null template.
java.util.Set<TemplateProxy>	findUsageOfActivityTemplate(SessionToken session, java.util.UUID activityTemplateVersionID) Finds all process templates which use the designated activity template in a process step.
RemoteIterator<java.util.List<TemplateProxy>>	findUsageOfActivityTemplateIterator(SessionToken session, java.util.UUID activityTemplateVersionID) The same as findUsageOfActivityTemplate(SessionToken, UUID) but with partial retrieval of the template proxies.
java.util.Set<TemplateProxy>	findUsageOfProcessTemplate(SessionToken session, java.util.UUID processTemplateID) Finds all process templates which reference the designated process template as subprocess.
RemoteIterator<java.util.List<TemplateProxy>>	findUsageOfProcessTemplateIterator(SessionToken session, java.util.UUID processTemplateID) The same as findUsageOfProcessTemplate(SessionToken, UUID) but with partial retrieval of the template proxies.
java.util.Set<ProcessType>	getAllProcessTypes(SessionToken session) Gets all process types in this repository.
RemoteIterator<java.util.List<ProcessType>>	getAllProcessTypesIterator(SessionToken session) The same as getAllProcessTypes(SessionToken) but with partial retrieval of the process types.
DataTypeManager	getDataTypeManager() Gets a reference to the management functions of user-defined data types which is provided by a separate state manager.
ProcessTemplateManager	getTemplateManager() Gets a reference to the management functions of process templates and types (creation and retrieval) which is provided by a separate template manager.
java.lang.String	getUniqueRepositoryName() Gets the unique name to identify this process repository.

Methods inherited from interface de.aristaflow.adept2.base.service.ADEPT2Service

getLocalUris, getRelease, getRuntimeRequiredServices, getServiceInstanceName, getStartupRequiredServices, getURIs, init, ping, preShutdown, shutdown, start

Method Detail

getAllProcessTypes

java.util.Set<ProcessType> getAllProcessTypes(SessionToken session)

Gets all process types in this repository. Process type are identified by a unique (with respect to the process repository) name and consist of a tree of process templates.

Parameters:

session - The session which is used to check for access rights on this method.

Returns:

A list of process type objects containing each a tree of process templates.

getAllProcessTypesIterator

RemoteIterator<java.util.List<ProcessType>> getAllProcessTypesIterator(SessionToken session)

The same as getAllProcessTypes(SessionToken) but with partial retrieval of the process types.

Parameters:

session - The session which is used to check for access rights on this method.

Returns:

An iterator providing process type objects containing each a tree of process templates.

createProcessType

ProcessType createProcessType(SessionToken session,
                              java.lang.String newProcessType)
                       throws InvalidLicenceException

Creates a new process type with the designated name, stores the liable user and creates the root template, which is just a copy of the implicit null template. The name of the process type must not exist.

Parameters:

session - The session which is used to check for access rights on this method and to retrieve the creating agent and the corresponding organisational position.

newProcessType - The name of the process type to be created. The name has to be unique (relative to the process repository).

Returns:

The newly created process type.

Throws:

InvalidLicenceException - If the current licence does not allow to create the designated process type, an InvalidLicenceException will be thrown.

java.lang.IllegalArgumentException - If the name of the new process type already exists, an IllegalArgumentException will be raised.

findUsageOfProcessTemplate

java.util.Set<TemplateProxy> findUsageOfProcessTemplate(SessionToken session,
                                                        java.util.UUID processTemplateID)

Finds all process templates which reference the designated process template as subprocess.

Parameters:

session - The session which is used to check for access rights on this method.

processTemplateID - The ID of the process template which is referenced as a subprocess.

Returns:

A set of (lightweight) process templates which contain the designated process template ID as subprocess.

findUsageOfProcessTemplateIterator

RemoteIterator<java.util.List<TemplateProxy>> findUsageOfProcessTemplateIterator(SessionToken session,
                                                                                 java.util.UUID processTemplateID)

The same as findUsageOfProcessTemplate(SessionToken, UUID) but with partial retrieval of the template proxies.

Parameters:

session - The session which is used to check for access rights on this method.

processTemplateID - The ID of the process template which is referenced as a subprocess.

Returns:

An iterator providing (lightweight) process templates which contain the designated process template ID as subprocess.

findUsageOfActivityTemplate

java.util.Set<TemplateProxy> findUsageOfActivityTemplate(SessionToken session,
                                                         java.util.UUID activityTemplateVersionID)

Finds all process templates which use the designated activity template in a process step.

Parameters:

session - The session which is used to check for access rights on this method.

activityTemplateVersionID - The ID of the activity template which usage is of interest.

Returns:

A set of (lightweight) process templates which reference the designated activity template.

findUsageOfActivityTemplateIterator

RemoteIterator<java.util.List<TemplateProxy>> findUsageOfActivityTemplateIterator(SessionToken session,
                                                                                  java.util.UUID activityTemplateVersionID)

The same as findUsageOfActivityTemplate(SessionToken, UUID) but with partial retrieval of the template proxies.

Parameters:

session - The session which is used to check for access rights on this method.

activityTemplateVersionID - The ID of the activity template which usage is of interest.

Returns:

An iterator providing (lightweight) process templates which reference the designated activity template.

getUniqueRepositoryName

java.lang.String getUniqueRepositoryName()

Gets the unique name to identify this process repository. The name is necessary because of the separation of process manager and process repository. It can be arbitrarily created as long as it is guaranteed to be globally unique.

Returns:

The globally unique name of this process repository.

getTemplateManager

ProcessTemplateManager getTemplateManager()

Gets a reference to the management functions of process templates and types (creation and retrieval) which is provided by a separate template manager.

Returns:

A reference to the process template manager of this process repository.

getDataTypeManager

DataTypeManager getDataTypeManager()

Gets a reference to the management functions of user-defined data types which is provided by a separate state manager. The data type manager is implicitly called when storing process templates with yet unknown user-defined data types.

Returns:

A reference to the data type manager of this process repository.