Package org.ametys.plugins.workspaces.project.notification

Class SetNotifiedFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.AbstractContentFunction

org.ametys.plugins.workspaces.project.notification.SetNotifiedFunction

All Implemented Interfaces:

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

public class SetNotifiedFunction
extends AbstractContentFunction

Function to mark that a news is notified

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 ContentTypesHelper	_cTypeHelper	The user manager
static final String	NOTIFIED_PROPERTY_NAME	Property to mark as notified

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

Method Summary

Modifier and Type	Method	Description
protected void	_markAsNotified(WorkflowAwareContent content, Map transientVars)	Mark the content as notified
protected void	_notifyObservers(WorkflowAwareContent content, Map transientVars)	Notify observers of news publication
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
void	service(ServiceManager manager)

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

NOTIFIED_PROPERTY_NAME

public static final String NOTIFIED_PROPERTY_NAME

Property to mark as notified

See Also:

• Constant Field Values

_cTypeHelper

protected ContentTypesHelper _cTypeHelper

The user manager

Constructor Details

SetNotifiedFunction

public SetNotifiedFunction()

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

_markAsNotified

protected void _markAsNotified(WorkflowAwareContent content,
 Map transientVars)

Mark the content as notified

Parameters:

content - the content

transientVars - the transient variables

_notifyObservers

protected void _notifyObservers(WorkflowAwareContent content,
 Map transientVars)
                         throws com.opensymphony.workflow.WorkflowException

Notify observers of news publication

Parameters:

content - the content

transientVars - the transient variables

Throws:

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

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