Package org.ametys.cms.workflow

Class DefaultWorkflowStepEnumerator

java.lang.Object

org.ametys.cms.workflow.DefaultWorkflowStepEnumerator

All Implemented Interfaces:

Enumerator, Configurable, Serviceable

Direct Known Subclasses:

WorkflowStepsEnumerator

public class DefaultWorkflowStepEnumerator
extends Object
implements Enumerator, Serviceable, Configurable

Enumerator for the default workflow steps

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_allOption	All option : 'disabled' to disable the 'all' option, 'blank' to use a blank value for 'all' option, or 'concat' to concat all content types' ids for 'all' option
protected List<Integer>	_excludedSteps	The workflow step to exclude
protected WorkflowHelper	_workflowHelper	The workflow helper
protected String	_workflowName	The workflow name

Constructor Summary

Constructors

Constructor	Description
DefaultWorkflowStepEnumerator()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
Map<String,Object>	getConfiguration()	Get the configuration this enumerator
Map<Object,I18nizableText>	getEntries()	Provides the enumerated values with their optional label.
I18nizableText	getEntry(String value)	Retrieves a single label from a value.
void	service(ServiceManager smanager)

Methods inherited from class java.lang.Object

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

Field Details

_workflowHelper

protected WorkflowHelper _workflowHelper

The workflow helper

_workflowName

protected String _workflowName

The workflow name

_allOption

protected String _allOption

All option : 'disabled' to disable the 'all' option, 'blank' to use a blank value for 'all' option, or 'concat' to concat all content types' ids for 'all' option

_excludedSteps

protected List<Integer> _excludedSteps

The workflow step to exclude

Constructor Details

DefaultWorkflowStepEnumerator

public DefaultWorkflowStepEnumerator()

Method Details

service

public void service(ServiceManager smanager)
             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

getConfiguration

public Map<String,Object> getConfiguration()

Description copied from interface: Enumerator

Get the configuration this enumerator

Specified by:

getConfiguration in interface Enumerator

Returns:

the configuration

getEntries

public Map<Object,I18nizableText> getEntries()
                                      throws Exception

Description copied from interface: Enumerator

Provides the enumerated values with their optional label.

Specified by:

getEntries in interface Enumerator

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs.

getEntry

public I18nizableText getEntry(String value)
                        throws Exception

Description copied from interface: Enumerator

Retrieves a single label from a value.

Specified by:

getEntry in interface Enumerator

Parameters:

value - the value.

Returns:

the label or null if not found.

Throws:

Exception - if an error occurs.