Package org.ametys.plugins.workflow

Class AmetysWorkflowFactory

java.lang.Object

com.opensymphony.workflow.loader.AbstractWorkflowFactory

org.ametys.plugins.workflow.AmetysWorkflowFactory

All Implemented Interfaces:

com.opensymphony.workflow.loader.WorkflowFactory, Component, Serviceable

public class AmetysWorkflowFactory
extends com.opensymphony.workflow.loader.AbstractWorkflowFactory
implements Component, Serviceable

The WorkflowFactory implementation for Ametys. Check the WorkflowDefinitionExtensionPoint and add the workflows from WEB-INF/param/workflows.

Field Summary

Fields

Modifier and Type	Field	Description
protected WorkflowDefinitionExtensionPoint	_workflowDefEP	The workflow definition extension point
static final String	ROLE	Avalon role.

Fields inherited from class com.opensymphony.workflow.loader.AbstractWorkflowFactory

properties

Constructor Summary

Constructors

Constructor	Description
AmetysWorkflowFactory()

Method Summary

Modifier and Type	Method	Description
void	createWorkflow(String name)
Object	getLayout(String workflowName)
String	getName()
com.opensymphony.workflow.loader.WorkflowDescriptor	getWorkflow(String name, boolean validate)
WorkflowDefinition	getWorkflowDefinition(String name)	Get the workflow definition by its name
String[]	getWorkflowNames()
void	initDone()
boolean	isModifiable(String name)
boolean	removeWorkflow(String name)
void	renameWorkflow(String oldName, String newName)
void	save()
boolean	saveWorkflow(String name, com.opensymphony.workflow.loader.WorkflowDescriptor descriptor, boolean replace)
void	service(ServiceManager manager)
void	setLayout(String workflowName, Object layout)

Methods inherited from class com.opensymphony.workflow.loader.AbstractWorkflowFactory

getProperties, getWorkflow, init

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ROLE

public static final String ROLE

Avalon role.

_workflowDefEP

protected WorkflowDefinitionExtensionPoint _workflowDefEP

The workflow definition extension point

Constructor Details

AmetysWorkflowFactory

public AmetysWorkflowFactory()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initDone

public void initDone()
              throws com.opensymphony.workflow.FactoryException

Specified by:

initDone in interface com.opensymphony.workflow.loader.WorkflowFactory

Overrides:

initDone in class com.opensymphony.workflow.loader.AbstractWorkflowFactory

Throws:

com.opensymphony.workflow.FactoryException

setLayout

public void setLayout(String workflowName,
 Object layout)

Specified by:

setLayout in interface com.opensymphony.workflow.loader.WorkflowFactory

getLayout

public Object getLayout(String workflowName)

Specified by:

getLayout in interface com.opensymphony.workflow.loader.WorkflowFactory

isModifiable

public boolean isModifiable(String name)

Specified by:

isModifiable in interface com.opensymphony.workflow.loader.WorkflowFactory

getName

public String getName()

Specified by:

getName in interface com.opensymphony.workflow.loader.WorkflowFactory

getWorkflow

public com.opensymphony.workflow.loader.WorkflowDescriptor getWorkflow(String name,
 boolean validate)
                                                                throws com.opensymphony.workflow.FactoryException

Specified by:

getWorkflow in interface com.opensymphony.workflow.loader.WorkflowFactory

Throws:

com.opensymphony.workflow.FactoryException

getWorkflowNames

public String[] getWorkflowNames()
                          throws com.opensymphony.workflow.FactoryException

Specified by:

getWorkflowNames in interface com.opensymphony.workflow.loader.WorkflowFactory

Throws:

com.opensymphony.workflow.FactoryException

createWorkflow

public void createWorkflow(String name)

Specified by:

createWorkflow in interface com.opensymphony.workflow.loader.WorkflowFactory

removeWorkflow

public boolean removeWorkflow(String name)
                       throws com.opensymphony.workflow.FactoryException

Specified by:

removeWorkflow in interface com.opensymphony.workflow.loader.WorkflowFactory

Throws:

com.opensymphony.workflow.FactoryException

renameWorkflow

public void renameWorkflow(String oldName,
 String newName)

Specified by:

renameWorkflow in interface com.opensymphony.workflow.loader.WorkflowFactory

save

public void save()

Specified by:

save in interface com.opensymphony.workflow.loader.WorkflowFactory

saveWorkflow

public boolean saveWorkflow(String name,
 com.opensymphony.workflow.loader.WorkflowDescriptor descriptor,
 boolean replace)
                     throws com.opensymphony.workflow.FactoryException

Specified by:

saveWorkflow in interface com.opensymphony.workflow.loader.WorkflowFactory

Throws:

com.opensymphony.workflow.FactoryException

getWorkflowDefinition

public WorkflowDefinition getWorkflowDefinition(String name)
                                         throws com.opensymphony.workflow.FactoryException

Get the workflow definition by its name

Parameters:

name - the name

Returns:

the workflow definition

Throws:

com.opensymphony.workflow.FactoryException - if an error occurs