Package org.ametys.plugins.workflow.definition

Class WorkflowDefinition

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workflow.definition.WorkflowDefinition

All Implemented Interfaces:

LogEnabled, PluginAware, Component, Configurable, Serviceable

Direct Known Subclasses:

AutomaticWorkflowDefinition

public class WorkflowDefinition
extends AbstractLogEnabled
implements Component, Serviceable, Configurable, PluginAware

Object to describe a workflow.

Field Summary

Fields

Modifier and Type	Field	Description
protected SourceResolver	_srcResolver	The source resolver
protected WorkflowHelper	_workflowHelper	The workflow helper

Constructor Summary

Constructors

Constructor	Description
WorkflowDefinition()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
String	getDefaultCatalog()	Get the default catalog for the workflow name.
protected InputStream	getDefinition()	Get the workflow definition
com.opensymphony.workflow.loader.WorkflowDescriptor	getDescriptor(boolean validate)	Get or load the workflow descriptor.
I18nizableText	getLabel()	Get the workflow label.
String	getLocation()	Get the location of the workflow file.
void	reset()	Method to reset the workflow.
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

_srcResolver

protected SourceResolver _srcResolver

The source resolver

_workflowHelper

protected WorkflowHelper _workflowHelper

The workflow helper

Constructor Details

WorkflowDefinition

public WorkflowDefinition()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getDefaultCatalog

public String getDefaultCatalog()

Get the default catalog for the workflow name.

Returns:

the default catalog

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

getLabel

public I18nizableText getLabel()

Get the workflow label.

Returns:

The workflow label, default is plugin.[pluginName]:WORKFLOW_[workflowNameUpperCased]

getLocation

public String getLocation()

Get the location of the workflow file.

Returns:

the location of the workflow file

getDescriptor

public com.opensymphony.workflow.loader.WorkflowDescriptor getDescriptor(boolean validate)
                                                                  throws Exception

Get or load the workflow descriptor.

Parameters:

validate - if the descriptor has to be valid

Returns:

the workflow descriptor

Throws:

Exception - if an error occurs

getDefinition

protected InputStream getDefinition()
                             throws IOException

Get the workflow definition

Returns:

the workflow definition

Throws:

IOException - if an error occurred

reset

public void reset()

Method to reset the workflow.