Package org.ametys.plugins.newsletter.workflow

Class CreateNewsletterFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.CreateContentFunction

org.ametys.web.workflow.CreateContentFunction

org.ametys.plugins.newsletter.workflow.CreateNewsletterFunction

All Implemented Interfaces:

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

public class CreateNewsletterFunction
extends CreateContentFunction
implements Initializable, Contextualizable

OSWorkflow function for creating a content.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	CreateNewsletterFunction.IgnoreRootTagHandler	Ignore the root tag.
protected class	CreateNewsletterFunction.NewsletterFilter	Automatic newsletter filter.

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 Context	_context	The Avalon context
protected static final String	_DEFAULT_LEVEL	The defaut content insertion level.
protected static final Set<String>	_IGNORE_ATTRS	The list of attributes to ignore.
static final String	NEWSLETTER_CATEGORY_KEY	Newsletter category key.
static final String	NEWSLETTER_CONTENT_ID_MAP_KEY	Key for content ID map when processing auto sections.
static final DateFormat	NEWSLETTER_DATE_FORMAT	The date format.
static final String	NEWSLETTER_DATE_KEY	Newsletter date key.
static final String	NEWSLETTER_IS_AUTOMATIC_KEY	Newsletter automatic property key.
static final String	NEWSLETTER_NUMBER_KEY	Newsletter number key.
static final String	NEWSLETTER_PROCESS_AUTO_SECTIONS_KEY	Key for "process auto sections".

Fields inherited from class org.ametys.web.workflow.CreateContentFunction

_currentUserProvider, _siteManager, PAGE_KEY, PAGE_ZONE_KEY, SITE_KEY

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

_contentTypeEP, _contentTypeHelper, _observationManager, _resolver, CONTENT_LANGUAGE_KEY, CONTENT_MIXINS_KEY, CONTENT_NAME_KEY, CONTENT_TITLE_KEY, CONTENT_TITLE_VARIANTS_KEY, CONTENT_TYPES_KEY, INITIAL_VALUE_SUPPLIER, PARENT_CONTEXT_VALUE, ROOT_CONTENT_PATH_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
CreateNewsletterFunction()

Method Summary

Modifier and Type	Method	Description
protected void	_populateContent(Map transientVars, ModifiableContent content)	Populate the content.
void	contextualize(Context context)
I18nizableText	getLabel()	Get the label for this function
void	initialize()
void	service(ServiceManager manager)

Methods inherited from class org.ametys.web.workflow.CreateContentFunction

_getContentRoot, _getObjectType, _notifyContentAdded, _populateAdditionalData

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

_createContent, _eventParamsForContentAdded, _getDefaultNameComputationMode, _getNameComputationMode, _getNonNullVar, _initWorkflow, _isMultilingual, _setTitle, execute, getFunctionExecType, getSystemUser

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

NEWSLETTER_CATEGORY_KEY

public static final String NEWSLETTER_CATEGORY_KEY

Newsletter category key.

NEWSLETTER_NUMBER_KEY

public static final String NEWSLETTER_NUMBER_KEY

Newsletter number key.

NEWSLETTER_DATE_KEY

public static final String NEWSLETTER_DATE_KEY

Newsletter date key.

NEWSLETTER_IS_AUTOMATIC_KEY

public static final String NEWSLETTER_IS_AUTOMATIC_KEY

Newsletter automatic property key.

NEWSLETTER_PROCESS_AUTO_SECTIONS_KEY

public static final String NEWSLETTER_PROCESS_AUTO_SECTIONS_KEY

Key for "process auto sections".

NEWSLETTER_CONTENT_ID_MAP_KEY

public static final String NEWSLETTER_CONTENT_ID_MAP_KEY

Key for content ID map when processing auto sections.

NEWSLETTER_DATE_FORMAT

public static final DateFormat NEWSLETTER_DATE_FORMAT

The date format.

_IGNORE_ATTRS

protected static final Set<String> _IGNORE_ATTRS

The list of attributes to ignore.

_DEFAULT_LEVEL

protected static final String _DEFAULT_LEVEL

The defaut content insertion level.

See Also:

• Constant Field Values

_context

protected Context _context

The Avalon context

Constructor Details

CreateNewsletterFunction

public CreateNewsletterFunction()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class CreateContentFunction

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getLabel

public I18nizableText getLabel()

Description copied from interface: EnhancedFunction

Get the label for this function

Specified by:

getLabel in interface EnhancedFunction

Overrides:

getLabel in class CreateContentFunction

Returns:

the label

_populateContent

protected void _populateContent(Map transientVars,
 ModifiableContent content)
                         throws com.opensymphony.workflow.WorkflowException

Description copied from class: CreateContentFunction

Populate the content.

Overrides:

_populateContent in class CreateContentFunction

Parameters:

transientVars - the transient variables.

content - the content.

Throws:

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