Package org.ametys.plugins.workflow

Class AbstractWorkflowComponent

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

All Implemented Interfaces:

LogEnabled, Serviceable

Direct Known Subclasses:

AbstractContentWorkflowComponent, AbstractExplorerNodeWorkflowComponent, AbstractNodeWorkflowComponent, ActiveEntryFunction, AmetysObjectCurrentStepCondition, CheckAllowedUsersCondition, CheckProcessCreatorCondition, CheckRightsCondition, EditProcessFunction, PilotageStatusCheckCondition, SetProcessCurrentStepId

public abstract class AbstractWorkflowComponent
extends Object
implements LogEnabled, Serviceable

Abstract class for easily retrieving environment components in a condition or a function.

Field Summary

Fields

Modifier and Type	Field	Description
protected Logger	_logger	Logger available to subclasses.
protected ServiceManager	_manager	Service manager available to subclasses.
static final String	CONTEXT_PARAMETERS_KEY	Constant for storing the content into the transient variables map.
static final String	FAIL_CONDITIONS_KEY	Constant for storing the content into the transient variables map.
static final String	RESULT_MAP_KEY	Constant for storing the result map into the transient variables map.
static final String	WORKFLOW_ERRORS_KEY	Constant for storing the workflow errors in result map.
static final String	WORKFLOW_WARNS_KEY	Constant for storing the workflow warnings in result map.

Constructor Summary

Constructors

Constructor	Description
AbstractWorkflowComponent()

Method Summary

Modifier and Type	Method	Description
void	addWorkflowError(Map transientVars, I18nizableText errorLabel)	Add a global workflow error such as fail condition
void	addWorkflowWarning(Map transientVars, I18nizableText warnLabel)	Add a global workflow errors that will be traited as warnings
void	enableLogging(Logger logger)
List<String>	getConditionFailures(Map transientVars)	Retrieve the list condition failures
Map<String,Object>	getContextParameters(Map transientVars)	Retrieve the workflow parameters map, or an empty map if there is no parameters
Map<String,Object>	getResultsMap(Map transientVars)	Retrieve the map to write return values
UserIdentity	getUser(Map transientVars)	Retrieve the user responsible of the call.
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

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

Field Details

CONTEXT_PARAMETERS_KEY

public static final String CONTEXT_PARAMETERS_KEY

Constant for storing the content into the transient variables map.

RESULT_MAP_KEY

public static final String RESULT_MAP_KEY

Constant for storing the result map into the transient variables map.

FAIL_CONDITIONS_KEY

public static final String FAIL_CONDITIONS_KEY

Constant for storing the content into the transient variables map.

WORKFLOW_ERRORS_KEY

public static final String WORKFLOW_ERRORS_KEY

Constant for storing the workflow errors in result map.

See Also:

• Constant Field Values

WORKFLOW_WARNS_KEY

public static final String WORKFLOW_WARNS_KEY

Constant for storing the workflow warnings in result map.

See Also:

• Constant Field Values

_manager

protected ServiceManager _manager

Service manager available to subclasses.

_logger

protected Logger _logger

Logger available to subclasses.

Constructor Details

AbstractWorkflowComponent

public AbstractWorkflowComponent()

Method Details

enableLogging

public void enableLogging(Logger logger)

Specified by:

enableLogging in interface LogEnabled

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getUser

public UserIdentity getUser(Map transientVars)
                     throws com.opensymphony.workflow.WorkflowException

Retrieve the user responsible of the call.

Parameters:

transientVars - the parameters from the call.

Returns:

the user responsible of the call.

Throws:

com.opensymphony.workflow.WorkflowException - if the user is not present.

getContextParameters

public Map<String,Object> getContextParameters(Map transientVars)
                                        throws com.opensymphony.workflow.WorkflowException

Retrieve the workflow parameters map, or an empty map if there is no parameters

Parameters:

transientVars - the parameters from the call.

Returns:

the workflow parameters map

Throws:

com.opensymphony.workflow.WorkflowException - if the object model or the request is not present.

getConditionFailures

public List<String> getConditionFailures(Map transientVars)
                                  throws com.opensymphony.workflow.WorkflowException

Retrieve the list condition failures

Parameters:

transientVars - the parameters from the call.

Returns:

the list of failed condition

Throws:

com.opensymphony.workflow.WorkflowException - If an error occurred

getResultsMap

public Map<String,Object> getResultsMap(Map transientVars)
                                 throws com.opensymphony.workflow.WorkflowException

Retrieve the map to write return values

Parameters:

transientVars - the parameters from the call.

Returns:

the map to render.

Throws:

com.opensymphony.workflow.WorkflowException - if the result map is not found.

addWorkflowError

public void addWorkflowError(Map transientVars,
 I18nizableText errorLabel)
                      throws com.opensymphony.workflow.WorkflowException

Add a global workflow error such as fail condition

Parameters:

transientVars - the parameters from the call.

errorLabel - The error label

Throws:

com.opensymphony.workflow.WorkflowException - if the result map is not found.

addWorkflowWarning

public void addWorkflowWarning(Map transientVars,
 I18nizableText warnLabel)
                        throws com.opensymphony.workflow.WorkflowException

Add a global workflow errors that will be traited as warnings

Parameters:

transientVars - the parameters from the call.

warnLabel - The warning label

Throws:

com.opensymphony.workflow.WorkflowException - if the result map is not found.