Package org.ametys.web.workflow

Class CreateContentFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.CreateContentFunction

org.ametys.web.workflow.CreateContentFunction

All Implemented Interfaces:

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

Direct Known Subclasses:

CreateNewsletterFunction

public class CreateContentFunction
extends CreateContentFunction

OSWorkflow function for creating a content.

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 CurrentUserProvider	_currentUserProvider	Current user provider
protected SiteManager	_siteManager	The sites manager
static final String	PAGE_KEY	Constant for knowing on which page the content will be affected.
static final String	PAGE_ZONE_KEY	Constant for knowing on which zone of the page to affect the content.
static final String	SITE_KEY	Constant for storing the site to use into the transient variables map.

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_CONTENT_ID_KEY, PARENT_CONTENT_METADATA_PATH_KEY, PARENT_CONTEXT_VALUE

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

Method Summary

Modifier and Type	Method	Description
protected AmetysObjectCollection<?,ModifiableWorkflowAwareContent>	_getContentRoot(Map transientVars)	Retrieve the content root.
protected String	_getObjectType(Map transientVars, Map args)	Return the type of the object to be created.
protected List<Future>	_notifyContentAdded(Content content, Map transientVars)	Notify observers that the content has been created
protected void	_populateAdditionalData(Map transientVars, ModifiableContent content)	Populate the content.
protected void	_populateContent(Map transientVars, ModifiableContent content)	Populate the content.
void	service(ServiceManager manager)

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

_createContent, _eventParamsForContentAdded, _getDefaultNameComputationMode, _getNameComputationMode, _getNonNullVar, _getSubContentRoot, _initWorkflow, _isMultilingual, _setTitle, execute, getArguments, getDescription, 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

Field Details

SITE_KEY

public static final String SITE_KEY

Constant for storing the site to use into the transient variables map.

PAGE_KEY

public static final String PAGE_KEY

Constant for knowing on which page the content will be affected.

PAGE_ZONE_KEY

public static final String PAGE_ZONE_KEY

Constant for knowing on which zone of the page to affect the content.

_siteManager

protected SiteManager _siteManager

The sites manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

Current user provider

Constructor Details

CreateContentFunction

public CreateContentFunction()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class CreateContentFunction

Throws:

ServiceException

_notifyContentAdded

protected List<Future> _notifyContentAdded(Content content,
 Map transientVars)
                                    throws com.opensymphony.workflow.WorkflowException

Description copied from class: CreateContentFunction

Notify observers that the content has been created

Overrides:

_notifyContentAdded in class CreateContentFunction

Parameters:

content - The content added

transientVars - The workflow vars

Returns:

The Future objects of the asynchronous observers

Throws:

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

_getObjectType

protected String _getObjectType(Map transientVars,
 Map args)

Description copied from class: CreateContentFunction

Return the type of the object to be created. Ex: ametys:defaultContent.

Overrides:

_getObjectType in class CreateContentFunction

Parameters:

transientVars - The workflow vars

args - The workflow function arguments

Returns:

The type of the object to be used during content creation.

_getContentRoot

protected AmetysObjectCollection<?,ModifiableWorkflowAwareContent> _getContentRoot(Map transientVars)
                                                                            throws com.opensymphony.workflow.WorkflowException

Description copied from class: CreateContentFunction

Retrieve the content root.

Overrides:

_getContentRoot in class CreateContentFunction

Parameters:

transientVars - the workflow parameters.

Returns:

the content root node.

Throws:

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

_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.

_populateAdditionalData

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

Description copied from class: CreateContentFunction

Populate the content.

Overrides:

_populateAdditionalData in class CreateContentFunction

Parameters:

transientVars - the transient variables.

content - the content.

Throws:

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