Package org.ametys.plugins.workflow.component

Class AmetysObjectCurrentStepCondition

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.plugins.workflow.component.AmetysObjectCurrentStepCondition

All Implemented Interfaces:

com.opensymphony.workflow.Condition, EnhancedCondition, LogEnabled, Serviceable

Direct Known Subclasses:

ContentCurrentStepCondition

public class AmetysObjectCurrentStepCondition
extends AbstractWorkflowComponent
implements EnhancedCondition

OSWorkflow condition to test the current step of an Ametys object The following configuration have to be used:

 <condition type="avalon">
   <arg name="role">org.ametys.plugins.workflow.component.AmetysObjectCurrentStepCondition</arg>
   <arg name="object-key">content</arg>
   <arg name="step">2</arg>
 </condition>
 

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.plugins.workflow.EnhancedCondition

EnhancedCondition.ConditionArgument

Field Summary

Fields inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

_logger, _manager, CONTEXT_PARAMETERS_KEY, FAIL_CONDITIONS_KEY, RESULT_MAP_KEY, WORKFLOW_ERRORS_KEY, WORKFLOW_WARNS_KEY

Constructor Summary

Constructors

Constructor	Description
AmetysObjectCurrentStepCondition()

Method Summary

Modifier and Type	Method	Description
protected Object	_getAmetysObjectKey(Map args)	Get the key to get the WorkflowAwareAmetysObject into the transient vars.
List<EnhancedCondition.ConditionArgument>	getArguments()	Get the list of accepted arguments for this condition
I18nizableText	getDescription(Map<String,String> argumentsValues)	Get the condition descriptions depending on arguments values
boolean	passesCondition(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)
void	service(ServiceManager manager)

Methods inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

addWorkflowError, addWorkflowWarning, enableLogging, getConditionFailures, getContextParameters, getResultsMap, getUser

Methods inherited from class java.lang.Object

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

Constructor Details

AmetysObjectCurrentStepCondition

public AmetysObjectCurrentStepCondition()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractWorkflowComponent

Throws:

ServiceException

passesCondition

public boolean passesCondition(Map transientVars,
 Map args,
 com.opensymphony.module.propertyset.PropertySet ps)
                        throws com.opensymphony.workflow.WorkflowException

Specified by:

passesCondition in interface com.opensymphony.workflow.Condition

Throws:

com.opensymphony.workflow.WorkflowException

_getAmetysObjectKey

protected Object _getAmetysObjectKey(Map args)

Get the key to get the WorkflowAwareAmetysObject into the transient vars.

Parameters:

args - Arguments of the condition

Returns:

A key to get the WorkflowAwareAmetysObject

getArguments

public List<EnhancedCondition.ConditionArgument> getArguments()

Description copied from interface: EnhancedCondition

Get the list of accepted arguments for this condition

Specified by:

getArguments in interface EnhancedCondition

Returns:

a List of argument names and associated description

getDescription

public I18nizableText getDescription(Map<String,String> argumentsValues)

Description copied from interface: EnhancedCondition

Get the condition descriptions depending on arguments values

Specified by:

getDescription in interface EnhancedCondition

Parameters:

argumentsValues - a map of the arguments with their values in current workflow

Returns:

a description to display in workflow editor vue