Package org.ametys.cms.workflow

Class RemoveLiveLabelFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.AbstractContentFunction

org.ametys.cms.workflow.RemoveLiveLabelFunction

All Implemented Interfaces:

com.opensymphony.workflow.FunctionProvider, EnhancedFunction, Initializable, LogEnabled, Serviceable

Direct Known Subclasses:

RemoveLiveLabelFunction

public class RemoveLiveLabelFunction
extends AbstractContentFunction

OSWorkflow function for validating a content.

Nested Class Summary

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

AbstractWorkflowComponent.ConditionFailure

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

EnhancedFunction.FunctionType

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	Current user provider
protected ObservationManager	_observerManager	Observer manager.

Fields inherited from class org.ametys.cms.workflow.AbstractContentFunction

_observationManager, _workflowProvider, EVENT_TO_NOTIFY_KEY

Fields inherited from class org.ametys.cms.workflow.AbstractContentWorkflowComponent

_contentHelper, CONTENT_KEY, HAS_CHANGED_KEY

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
RemoveLiveLabelFunction()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	_getEventParams(WorkflowAwareContent content)	Get the event params for notifications.
void	execute(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)
EnhancedFunction.FunctionType	getFunctionExecType()	Return the type for the function
I18nizableText	getLabel()	Get the label for this function
protected void	notifyObservers(WorkflowAwareContent content)	Notify observers of content validation
void	service(ServiceManager manager)
protected void	unpublishContent(WorkflowAwareContent content)	Unpublish the content.

Methods inherited from class org.ametys.cms.workflow.AbstractContentFunction

_addLabel, _addLockToken, _createVersion, _getDefaultEvent, _notify, _setCurrentStepId, _setCurrentStepIdAndNotify, initialize

Methods inherited from class org.ametys.cms.workflow.AbstractContentWorkflowComponent

getContent

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

Methods inherited from interface org.ametys.plugins.workflow.EnhancedFunction

getArguments, getFullLabel, getVisibilities

Field Details

_observerManager

protected ObservationManager _observerManager

Observer manager.

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

Current user provider

Constructor Details

RemoveLiveLabelFunction

public RemoveLiveLabelFunction()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractContentWorkflowComponent

Throws:

ServiceException

execute

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

Throws:

com.opensymphony.workflow.WorkflowException

notifyObservers

protected void notifyObservers(WorkflowAwareContent content)

Notify observers of content validation

Parameters:

content - The content to unpublish

_getEventParams

protected Map<String,Object> _getEventParams(WorkflowAwareContent content)

Get the event params for notifications.

Parameters:

content - The content to unpublish

Returns:

a Map of params

unpublishContent

protected void unpublishContent(WorkflowAwareContent content)
                         throws com.opensymphony.workflow.WorkflowException

Unpublish the content.

Parameters:

content - the content to unpublish.

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs.

getFunctionExecType

public EnhancedFunction.FunctionType getFunctionExecType()

Description copied from interface: EnhancedFunction

Return the type for the function

Returns:

the type 's code

getLabel

public I18nizableText getLabel()

Description copied from interface: EnhancedFunction

Get the label for this function

Returns:

the label