Package 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:

AbstractCodeEditionFunction, AbstractContentFunction, CheckDuplicateContentsFunction, CreateContentFunction, DeleteContentFunction, DeleteRemoteProgramFunction, DepositCDMFRFunction, EditContentFunction, ExtractOutgoingReferencesFunction, FormEditionFunction, HasLiveLabelCondition, InitContentFunction, LockCondition, MarkContentArchivedFunction, NotifyCopyFunction, PublishableODFContentCondition, SendCDMFRFunction, SendMailFunction, SendNewsletterFunction, SendNewsPublicationNotificationCondition, SetProposalDateContentFunction, TranslationAlertFunction, UnlockContentFunction, ValidateContentCondition, ValidateProgramItemTreeCondition

public abstract class AbstractContentWorkflowComponent
extends AbstractWorkflowComponent

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

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

AbstractWorkflowComponent.ConditionFailure

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentHelper	_contentHelper	The content helper
static final String	CONTENT_KEY	Constant for storing the content into the transient variables map.
static final String	HAS_CHANGED_KEY	Constant for storing the content's state (has changed or not) 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_VALIDATION_KEY

Constructor Summary

Constructors

Constructor	Description
AbstractContentWorkflowComponent()

Method Summary

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

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

Field Details

CONTENT_KEY

public static final String CONTENT_KEY

Constant for storing the content into the transient variables map.

HAS_CHANGED_KEY

public static final String HAS_CHANGED_KEY

Constant for storing the content's state (has changed or not) into the transient variables map.

See Also:

• Constant Field Values

_contentHelper

protected ContentHelper _contentHelper

The content helper

Constructor Details

AbstractContentWorkflowComponent

public AbstractContentWorkflowComponent()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractWorkflowComponent

Throws:

ServiceException

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.