Package org.ametys.plugins.newsletter.workflow

Class SendNewsletterFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.plugins.newsletter.workflow.SendNewsletterFunction

All Implemented Interfaces:

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

public class SendNewsletterFunction
extends AbstractContentWorkflowComponent
implements EnhancedFunction, Contextualizable

OSWorkflow function for creating 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 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
SendNewsletterFunction()

Method Summary

Modifier and Type	Method	Description
protected CategoryProvider	_getProvider(String categoryID)	Get the category provider
protected Request	_getRequest()	Retrieve the request from which this component is called.
protected List<Subscriber>	_getSubscribersOfChildCategories(String categoryID, String siteName)	Get the subscribers of child categories
protected List<Subscriber>	_getSubscribersOfParentCategories(String categoryID, String siteName)	Get the subscribers of parent categories
void	contextualize(Context context)
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.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

Constructor Details

SendNewsletterFunction

public SendNewsletterFunction()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractContentWorkflowComponent

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

execute

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

Specified by:

execute in interface com.opensymphony.workflow.FunctionProvider

Throws:

com.opensymphony.workflow.WorkflowException

_getSubscribersOfParentCategories

protected List<Subscriber> _getSubscribersOfParentCategories(String categoryID,
 String siteName)

Get the subscribers of parent categories

Parameters:

categoryID - The category id

siteName - The site name

Returns:

the subscribers of parent categories

_getSubscribersOfChildCategories

protected List<Subscriber> _getSubscribersOfChildCategories(String categoryID,
 String siteName)

Get the subscribers of child categories

Parameters:

categoryID - The category id

siteName - The site name

Returns:

The subscribers of child categories

_getRequest

protected Request _getRequest()

Retrieve the request from which this component is called.

Returns:

the request

_getProvider

protected CategoryProvider _getProvider(String categoryID)

Get the category provider

Parameters:

categoryID - The category id

Returns:

The category

getFunctionExecType

public EnhancedFunction.FunctionType getFunctionExecType()

Description copied from interface: EnhancedFunction

Return the type for the function

Specified by:

getFunctionExecType in interface EnhancedFunction

Returns:

the type 's code

getLabel

public I18nizableText getLabel()

Description copied from interface: EnhancedFunction

Get the label for this function

Specified by:

getLabel in interface EnhancedFunction

Returns:

the label