org.ametys.plugins.bpm.jcr

Class JCRWorkflow

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.plugins.repository.jcr.SimpleAmetysObject<F>

org.ametys.plugins.repository.jcr.DefaultTraversableAmetysObject<JCRWorkflowFactory>

org.ametys.plugins.bpm.jcr.JCRWorkflow

All Implemented Interfaces:

Workflow, ACLAmetysObject, AmetysObject, JCRAmetysObject, JCRTraversableAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableTraversableAmetysObject, RemovableAmetysObject, TraversableAmetysObject

public class JCRWorkflow
extends DefaultTraversableAmetysObject<JCRWorkflowFactory>
implements Workflow

Class representing of workflow, backed by a JCR node.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	NODE_NAME_ALLOWED_GROUP
private static String	NODE_NAME_ALLOWED_GROUPS
private static String	NODE_NAME_ALLOWED_USER
private static String	NODE_NAME_ALLOWED_USERS
private static String	NODE_NAME_ATTACHMENTS
private static String	NODE_NAME_OWNER
private static String	NODE_NAME_WORKFLOW_VARIABLES
private static String	PROPERTY_DESCRIPTION
private static String	PROPERTY_TITLE
private static String	PROPERTY_WORKFLOW_DEFINITION

Constructor Summary

Constructors

Constructor and Description
JCRWorkflow(Node node, String parentPath, JCRWorkflowFactory factory) Creates an JCRWorkflow.

Method Summary

Modifier and Type	Method and Description
GroupIdentity[]	getAllowedGroups() Get the list of groups allowed to create a process from this workflow
UserIdentity[]	getAllowedUsers() Get the list of users allowed to create a process from this workflow
String	getDescription() Get the workflow description
UserIdentity	getOwner() Get the owner of the workflow
ResourceCollection	getRootAttachments() Retrieves the attachments root node
String	getTitle() Get the workflow title
Object	getVariable(String variableName) Get the value of a variable of the workflow
String	getWorkflowDefinition() Get the workflow definition linked to this workflow
void	setAllowedGroups(GroupIdentity[] allowedGroups) Set the list of groups allowed to create a process from this workflow
void	setAllowedUsers(UserIdentity[] allowedUsers) Set the list of users allowed to create a process from this workflow
void	setDescription(String description) Set the workflow description
void	setOwner(UserIdentity owner) Set the owner of the workflow
void	setTitle(String title) Set the workflow title
void	setVariable(String variableName, Object value) Set the value of a variable of the workflow
void	setWorkflowDefinition(String workflowDefId) Set the workflow definition linked to this workflow

Methods inherited from class org.ametys.plugins.repository.jcr.DefaultTraversableAmetysObject

addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, createChild, getAllowedGroups, getAllowedProfilesForAnonymous, getAllowedProfilesForAnyConnectedUser, getAllowedProfilesForGroups, getAllowedProfilesForUser, getAllowedProfilesForUsers, getAllowedUsers, getChild, getChildren, getDeniedGroups, getDeniedProfilesForAnonymous, getDeniedProfilesForAnyConnectedUser, getDeniedProfilesForGroups, getDeniedProfilesForUser, getDeniedProfilesForUsers, getDeniedUsers, hasChild, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsers

Methods inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObject

_getFactory, _invalidateName, _invalidateParentPath, getId, getMetadataHolder, getName, getNode, getParent, getParentPath, getPath, needsSave, remove, rename, revertChanges, saveChanges

Methods inherited from class org.ametys.plugins.repository.AbstractAmetysObject

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ametys.plugins.repository.jcr.JCRAmetysObject

getNode

Methods inherited from interface org.ametys.plugins.repository.metadata.ModifiableMetadataAwareAmetysObject

getMetadataHolder

Methods inherited from interface org.ametys.plugins.repository.ModifiableAmetysObject

needsSave, rename, revertChanges, saveChanges

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Methods inherited from interface org.ametys.plugins.repository.RemovableAmetysObject

remove

Methods inherited from interface org.ametys.plugins.repository.TraversableAmetysObject

getChildAt, getChildPosition

Field Detail

PROPERTY_DESCRIPTION

private static final String PROPERTY_DESCRIPTION

See Also:

Constant Field Values

PROPERTY_TITLE

private static final String PROPERTY_TITLE

See Also:

Constant Field Values

NODE_NAME_OWNER

private static final String NODE_NAME_OWNER

See Also:

Constant Field Values

PROPERTY_WORKFLOW_DEFINITION

private static final String PROPERTY_WORKFLOW_DEFINITION

See Also:

Constant Field Values

NODE_NAME_ALLOWED_USERS

private static final String NODE_NAME_ALLOWED_USERS

See Also:

Constant Field Values

NODE_NAME_ALLOWED_USER

private static final String NODE_NAME_ALLOWED_USER

See Also:

Constant Field Values

NODE_NAME_ALLOWED_GROUPS

private static final String NODE_NAME_ALLOWED_GROUPS

See Also:

Constant Field Values

NODE_NAME_ALLOWED_GROUP

private static final String NODE_NAME_ALLOWED_GROUP

See Also:

Constant Field Values

NODE_NAME_WORKFLOW_VARIABLES

private static final String NODE_NAME_WORKFLOW_VARIABLES

See Also:

Constant Field Values

NODE_NAME_ATTACHMENTS

private static final String NODE_NAME_ATTACHMENTS

See Also:

Constant Field Values

Constructor Detail

JCRWorkflow

public JCRWorkflow(Node node,
                   String parentPath,
                   JCRWorkflowFactory factory)

Creates an JCRWorkflow.

Parameters:

node - the node backing this AmetysObject

parentPath - the parentPath in the Ametys hierarchy

factory - the JCRWorkflowFactory which created the AmetysObject

Method Detail

getTitle

public String getTitle()
                throws AmetysRepositoryException

Description copied from interface: Workflow

Get the workflow title

Specified by:

getTitle in interface Workflow

Returns:

The workflow title

Throws:

AmetysRepositoryException - If a repository error occurred

setTitle

public void setTitle(String title)

Description copied from interface: Workflow

Set the workflow title

Specified by:

setTitle in interface Workflow

Parameters:

title - The title

getWorkflowDefinition

public String getWorkflowDefinition()
                             throws AmetysRepositoryException

Description copied from interface: Workflow

Get the workflow definition linked to this workflow

Specified by:

getWorkflowDefinition in interface Workflow

Returns:

The workflow definition id

Throws:

AmetysRepositoryException - If a repository error occurred

setWorkflowDefinition

public void setWorkflowDefinition(String workflowDefId)

Description copied from interface: Workflow

Set the workflow definition linked to this workflow

Specified by:

setWorkflowDefinition in interface Workflow

Parameters:

workflowDefId - The workflow definition id

getDescription

public String getDescription()
                      throws AmetysRepositoryException

Description copied from interface: Workflow

Get the workflow description

Specified by:

getDescription in interface Workflow

Returns:

The description

Throws:

AmetysRepositoryException - If a repository error occurred

setDescription

public void setDescription(String description)

Description copied from interface: Workflow

Set the workflow description

Specified by:

setDescription in interface Workflow

Parameters:

description - The description

getVariable

public Object getVariable(String variableName)
                   throws AmetysRepositoryException

Description copied from interface: Workflow

Get the value of a variable of the workflow

Specified by:

getVariable in interface Workflow

Parameters:

variableName - The name of the variable to retrieve

Returns:

The value of the variable

Throws:

AmetysRepositoryException - If a repository error occurred

setVariable

public void setVariable(String variableName,
                        Object value)

Description copied from interface: Workflow

Set the value of a variable of the workflow

Specified by:

setVariable in interface Workflow

Parameters:

variableName - The name of the variable to set

value - The value to set

getOwner

public UserIdentity getOwner()
                      throws AmetysRepositoryException

Description copied from interface: Workflow

Get the owner of the workflow

Specified by:

getOwner in interface Workflow

Returns:

The owner

Throws:

AmetysRepositoryException - If a repository error occurred

setOwner

public void setOwner(UserIdentity owner)

Description copied from interface: Workflow

Set the owner of the workflow

Specified by:

setOwner in interface Workflow

Parameters:

owner - The owner

getAllowedUsers

public UserIdentity[] getAllowedUsers()
                               throws AmetysRepositoryException

Description copied from interface: Workflow

Get the list of users allowed to create a process from this workflow

Specified by:

getAllowedUsers in interface Workflow

Returns:

The list of allowed users

Throws:

AmetysRepositoryException - If a repository error occurred

setAllowedUsers

public void setAllowedUsers(UserIdentity[] allowedUsers)

Description copied from interface: Workflow

Set the list of users allowed to create a process from this workflow

Specified by:

setAllowedUsers in interface Workflow

Parameters:

allowedUsers - The list of allowed users

getAllowedGroups

public GroupIdentity[] getAllowedGroups()
                                 throws AmetysRepositoryException

Description copied from interface: Workflow

Get the list of groups allowed to create a process from this workflow

Specified by:

getAllowedGroups in interface Workflow

Returns:

The list of allowed groups

Throws:

AmetysRepositoryException - If a repository error occurred

setAllowedGroups

public void setAllowedGroups(GroupIdentity[] allowedGroups)

Description copied from interface: Workflow

Set the list of groups allowed to create a process from this workflow

Specified by:

setAllowedGroups in interface Workflow

Parameters:

allowedGroups - The list of allowed groups

getRootAttachments

public ResourceCollection getRootAttachments()
                                      throws AmetysRepositoryException

Description copied from interface: Workflow

Retrieves the attachments root node

Specified by:

getRootAttachments in interface Workflow

Returns:

The the attachments root node

Throws:

AmetysRepositoryException - if an error occurs.