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 interface org.ametys.plugins.workflow.EnhancedFunction

EnhancedFunction.FunctionArgument

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

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_ERRORS_KEY, WORKFLOW_WARNS_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)
List<EnhancedFunction.FunctionArgument>	getArguments()	Get the list of accepted arguments for this function
I18nizableText	getDescription(Map<String,String> args)	Get the function descriptions depending on arguments values
void	service(ServiceManager manager)

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

_addLabel, _addLockToken, _createVersion, _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

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

getArguments

public List<EnhancedFunction.FunctionArgument> getArguments()

Description copied from interface: EnhancedFunction

Get the list of accepted arguments for this function

Returns:

a List of argument names and associated description

getDescription

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

Description copied from interface: EnhancedFunction

Get the function descriptions depending on arguments values

Parameters:

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

Returns:

a description to display in workflow editor vue