org.ametys.cms.workflow

Class AbstractContentWorkflowComponent

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

All Implemented Interfaces:

LogEnabled, Serviceable

Direct Known Subclasses:

AbstractContentFunction, ContentPublishedCondition, CreateContentFunction, DeleteContentFunction, EditContentByCopyFunction, EditContentFunction, FormEditionFunction, LockCondition, MarkContentArchivedFunction, SendMailFunction, SendNewsletterFunction, SetProposalDateContentFunction, TranslationAlertFunction, UnlockContentFunction, UnpublishContentFunction, ValidateMetadataCondition

public abstract class AbstractContentWorkflowComponent
extends AbstractWorkflowComponent

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_KEY Constant for storing the content into the transient variables map.

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 and Description
AbstractContentWorkflowComponent()

Method Summary

Modifier and Type	Method and Description
protected WorkflowAwareContent	getContent(Map transientVars) Retrieve the content associated with the workflow.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_KEY

public static final String CONTENT_KEY

Constant for storing the content into the transient variables map.

Constructor Detail

AbstractContentWorkflowComponent

public AbstractContentWorkflowComponent()

Method Detail

getContent

protected WorkflowAwareContent getContent(Map transientVars)
                                   throws com.opensymphony.workflow.WorkflowException

Retrieve the content associated with the workflow.

Parameters:

transientVars - the parameters from the call.

Returns:

the content.

Throws:

com.opensymphony.workflow.WorkflowException - if the content is not found.