Package org.ametys.web.workflow

Class CreateContentByCopyFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.CreateContentFunction

org.ametys.cms.workflow.copy.CreateContentByCopyFunction

org.ametys.web.workflow.CreateContentByCopyFunction

All Implemented Interfaces:

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

public class CreateContentByCopyFunction
extends CreateContentByCopyFunction

OSWorkflow function to create a content by copy of another The required transient variables: - CreateContentByCopyFunction.BASE_CONTENT_KEY - Content The content that will be used for duplication. - or CreateContentByCopyFunction.BASE_CONTENT_ID - String The id of content The content that will be used for duplication. - CreateContentByCopyFunction.COPY_MAP_KEY - Map<String, Object> The map of properties to copy. Can be null if CreateContentByCopyFunction.COPY_VIEW_NAME is used - CreateContentByCopyFunction.SITE_KEY - The content's site name

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 SiteManager	_siteManager	The sites manager
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.copy.CreateContentByCopyFunction

_copyContentComponent, _cTypesHelper, _i18nUtils, BASE_CONTENT_ID, BASE_CONTENT_KEY, COPY_FALLBACK_VIEW_NAME, COPY_MAP_KEY, COPY_REPORT_KEY, COPY_VIEW_NAME

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

Method Summary

Modifier and Type	Method	Description
protected ModifiableTraversableAmetysObject	_getContentRoot(Map transientVars)	Retrieve the content root.
protected String	_getObjectType(Map transientVars, Map args)	Return the type of the object to be created.
protected void	_populateContent(Map transientVars, ModifiableContent content)	Populate the content.
I18nizableText	getLabel()	Get the label for this function
void	service(ServiceManager manager)

Methods inherited from class org.ametys.cms.workflow.copy.CreateContentByCopyFunction

execute, getAdditionalCopyMap, getBaseContentForCopy, processValues

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

_createContent, _eventParamsForContentAdded, _getDefaultNameComputationMode, _getNameComputationMode, _getNonNullVar, _initWorkflow, _isMultilingual, _notifyContentAdded, _populateAdditionalData, _setTitle, 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

SITE_KEY

public static final String SITE_KEY

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

_siteManager

protected SiteManager _siteManager

The sites manager

Constructor Details

CreateContentByCopyFunction

public CreateContentByCopyFunction()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class CreateContentByCopyFunction

Throws:

ServiceException

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

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 CreateContentByCopyFunction

Returns:

the label