org.ametys.plugins.bpm

Interface Workflow

All Known Implementing Classes:

JCRWorkflow

public interface Workflow

Common interface for a Workflow in the Business Process Management

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

Method Detail

getTitle

String getTitle()
         throws AmetysRepositoryException

Get the workflow title

Returns:

The workflow title

Throws:

AmetysRepositoryException - If a repository error occurred

setTitle

void setTitle(String title)
       throws AmetysRepositoryException

Set the workflow title

Parameters:

title - The title

Throws:

AmetysRepositoryException - If a repository error occurred

getWorkflowDefinition

String getWorkflowDefinition()
                      throws AmetysRepositoryException

Get the workflow definition linked to this workflow

Returns:

The workflow definition id

Throws:

AmetysRepositoryException - If a repository error occurred

setWorkflowDefinition

void setWorkflowDefinition(String workflowDefId)
                    throws AmetysRepositoryException

Set the workflow definition linked to this workflow

Parameters:

workflowDefId - The workflow definition id

Throws:

AmetysRepositoryException - If a repository error occurred

getDescription

String getDescription()
               throws AmetysRepositoryException

Get the workflow description

Returns:

The description

Throws:

AmetysRepositoryException - If a repository error occurred

setDescription

void setDescription(String description)
             throws AmetysRepositoryException

Set the workflow description

Parameters:

description - The description

Throws:

AmetysRepositoryException - If a repository error occurred

getVariable

Object getVariable(String variableName)
            throws AmetysRepositoryException

Get the value of a variable of the workflow

Parameters:

variableName - The name of the variable to retrieve

Returns:

The value of the variable

Throws:

AmetysRepositoryException - If a repository error occurred

setVariable

void setVariable(String variableName,
                 Object value)
          throws AmetysRepositoryException

Set the value of a variable of the workflow

Parameters:

variableName - The name of the variable to set

value - The value to set

Throws:

AmetysRepositoryException - If a repository error occurred

getOwner

UserIdentity getOwner()
               throws AmetysRepositoryException

Get the owner of the workflow

Returns:

The owner

Throws:

AmetysRepositoryException - If a repository error occurred

setOwner

void setOwner(UserIdentity owner)
       throws AmetysRepositoryException

Set the owner of the workflow

Parameters:

owner - The owner

Throws:

AmetysRepositoryException - If a repository error occurred

getAllowedUsers

UserIdentity[] getAllowedUsers()
                        throws AmetysRepositoryException

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

Returns:

The list of allowed users

Throws:

AmetysRepositoryException - If a repository error occurred

setAllowedUsers

void setAllowedUsers(UserIdentity[] allowedUsers)
              throws AmetysRepositoryException

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

Parameters:

allowedUsers - The list of allowed users

Throws:

AmetysRepositoryException - If a repository error occurred

getAllowedGroups

GroupIdentity[] getAllowedGroups()
                          throws AmetysRepositoryException

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

Returns:

The list of allowed groups

Throws:

AmetysRepositoryException - If a repository error occurred

setAllowedGroups

void setAllowedGroups(GroupIdentity[] allowedGroups)
               throws AmetysRepositoryException

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

Parameters:

allowedGroups - The list of allowed groups

Throws:

AmetysRepositoryException - If a repository error occurred

getRootAttachments

ResourceCollection getRootAttachments()
                               throws AmetysRepositoryException

Retrieves the attachments root node

Returns:

The the attachments root node

Throws:

AmetysRepositoryException - if an error occurs.