Package nl.gx.webmanager.cms.workflow

Interface WorkflowModel

All Superinterfaces:

Wrapper

public interface WorkflowModel
extends Wrapper

This interface represents a Workflow model. A Workflow model is based on a Workflow repository model and additionally assigns roles to the activities. Furthermore a Workflow model defines the roles that are allowed to modify the Workflow model

Author:

ivol

Method Summary

Modifier and Type	Method	Description
WorkflowModel	copy()	Copy the Workflow model and return the copy.
WorkflowModelInstance	createInstance(String name)	Deprecated. Use WorkflowService.createWorkflowModelInstance(WorkflowModel) instead
Role[]	getRoles(WorkflowActivity workflowActivity)	Return the roles assigned by this Workflow model to the given Workflow activity.
WorkflowActivityRole[]	getWorkflowActivityRoles()	Return an array containing all Workflow activity roles.
WorkflowRepositoryModel	getWorkflowRepositoryModel()	Return the Workflow repository model on which the Workflow model is based.
boolean	isUserModifier()	Returns true if the current user has the rights to modify this WorkflowModel object.
void	setWorkflowRepositoryModel(WorkflowRepositoryModel workflowRepositoryModel)	Sets the WorkflowRepositoryModel on this WorkflowModel to the value of the workflowRepositoryModel parameter and synchronizes the WorkflowActivityRole objects of this WorkflowModel accordingly.
void	setWorklowActivityRoles(WorkflowActivityRole[] workflowActivityRoles)	Sets the activity roles on this WorkflowModel to the WorkflowActivityRole objects passed by the workflowActivityRoles parameter.

Methods inherited from interface nl.gx.webmanager.wrapper.Wrapper

getId, getUUID, setId, setUUID

Method Detail

getWorkflowRepositoryModel

WorkflowRepositoryModel getWorkflowRepositoryModel()

Return the Workflow repository model on which the Workflow model is based.

Returns:

the Workflow repository model on which the Workflow model is based.

setWorkflowRepositoryModel

void setWorkflowRepositoryModel(WorkflowRepositoryModel workflowRepositoryModel)
                         throws IllegalArgumentException

Sets the WorkflowRepositoryModel on this WorkflowModel to the value of the workflowRepositoryModel parameter and synchronizes the WorkflowActivityRole objects of this WorkflowModel accordingly. TODO: Publishes an "Update" event in case the value of the workflowRepositoryModel parameter is different from the currently assigned WorkflowRepositoryModel (do this in the context of GXWM-29199).

Parameters:

workflowRepositoryModel - The WorkflowRepositoryModel which is assigned.

Throws:

IllegalArgumentException - In case a null value is passed in the workflowRepositoryModel parameter

createInstance

@Deprecated
WorkflowModelInstance createInstance(String name)

Deprecated.

Use WorkflowService.createWorkflowModelInstance(WorkflowModel) instead

Creates a new instance of this Workflow model with the given name.

Parameters:

name - Name of the Workflow model instance to create

Returns:

New instance of this Workflow model

copy

WorkflowModel copy()

Copy the Workflow model and return the copy.

Returns:

Copy of the Workflow model

getWorkflowActivityRoles

WorkflowActivityRole[] getWorkflowActivityRoles()

Return an array containing all Workflow activity roles. These are activity - role mappings for the Workflow model.

Returns:

array containing all Workflow activity roles

setWorklowActivityRoles

void setWorklowActivityRoles(WorkflowActivityRole[] workflowActivityRoles)

Sets the activity roles on this WorkflowModel to the WorkflowActivityRole objects passed by the workflowActivityRoles parameter.

Parameters:

workflowActivityRoles - the WorkflowActivityRole objects to set on this WorkflowModel

getRoles

Role[] getRoles(WorkflowActivity workflowActivity)

Return the roles assigned by this Workflow model to the given Workflow activity.

Parameters:

workflowActivity - Workflow activity to retrieve the roles for

Returns:

roles assigned by this Workflow model to the given Workflow activity

isUserModifier

boolean isUserModifier()

Returns true if the current user has the rights to modify this WorkflowModel object.

Returns:

true if the current user has the rights to modify this WorkflowModel object