org.ametys.plugins.bpm

Interface WorkflowProcess

All Known Implementing Classes:

JCRWorkflowProcess

public interface WorkflowProcess

Common interface for a Process in the Business Process Management

Method Summary

Modifier and Type	Method and Description
Date	getCreationDate() Get the creation date of the process
UserIdentity	getCreator() Get the creator of the process
String	getDescription() Get the process description
ResourceCollection	getRootAttachments(boolean create) Retrieves the attachments root node
String	getSite() Get the site where the process was created
String	getTitle() Get the process title
String	getWorkflow() Get the workflow linked to this process
void	setCreationDate(Date creationDate) Set the creation date of the process
void	setCreator(UserIdentity creator) Set the creator of the process
void	setDescription(String description) Set the process description
void	setSite(String site) Set the site where the process was created
void	setTitle(String title) Set the process title
void	setWorkflow(String workflowId) Set the workflow linked to this process

Method Detail

getTitle

String getTitle()
         throws AmetysRepositoryException

Get the process title

Returns:

The process title

Throws:

AmetysRepositoryException - If a repository error occurred

setTitle

void setTitle(String title)
       throws AmetysRepositoryException

Set the process title

Parameters:

title - The title

Throws:

AmetysRepositoryException - If a repository error occurred

getWorkflow

String getWorkflow()
            throws AmetysRepositoryException

Get the workflow linked to this process

Returns:

The workflow id

Throws:

AmetysRepositoryException - If a repository error occurred

setWorkflow

void setWorkflow(String workflowId)
          throws AmetysRepositoryException

Set the workflow linked to this process

Parameters:

workflowId - The workflow id

Throws:

AmetysRepositoryException - If a repository error occurred

getDescription

String getDescription()
               throws AmetysRepositoryException

Get the process description

Returns:

The description

Throws:

AmetysRepositoryException - If a repository error occurred

setDescription

void setDescription(String description)
             throws AmetysRepositoryException

Set the process description

Parameters:

description - The description

Throws:

AmetysRepositoryException - If a repository error occurred

getCreator

UserIdentity getCreator()
                 throws AmetysRepositoryException

Get the creator of the process

Returns:

The creator

Throws:

AmetysRepositoryException - If a repository error occurred

setCreator

void setCreator(UserIdentity creator)
         throws AmetysRepositoryException

Set the creator of the process

Parameters:

creator - The creator

Throws:

AmetysRepositoryException - If a repository error occurred

getSite

String getSite()
        throws AmetysRepositoryException

Get the site where the process was created

Returns:

The site

Throws:

AmetysRepositoryException - If a repository error occurred

setSite

void setSite(String site)
      throws AmetysRepositoryException

Set the site where the process was created

Parameters:

site - The site

Throws:

AmetysRepositoryException - If a repository error occurred

getCreationDate

Date getCreationDate()
              throws AmetysRepositoryException

Get the creation date of the process

Returns:

The creation date

Throws:

AmetysRepositoryException - If a repository error occurred

setCreationDate

void setCreationDate(Date creationDate)
              throws AmetysRepositoryException

Set the creation date of the process

Parameters:

creationDate - The creation date

Throws:

AmetysRepositoryException - If a repository error occurred

getRootAttachments

ResourceCollection getRootAttachments(boolean create)
                               throws AmetysRepositoryException

Retrieves the attachments root node

Parameters:

create - True to create the node if it does not exist

Returns:

The attachments root node.

Throws:

AmetysRepositoryException - if an error occurs.