Package org.ametys.odf.workflow.copy

Class AbstractCreateProgramItemByCopyFunction

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.odf.workflow.copy.AbstractCreateODFContentByCopyFunction

org.ametys.odf.workflow.copy.AbstractCreateProgramItemByCopyFunction

All Implemented Interfaces:

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

Direct Known Subclasses:

CreateContainerByCopyFunction, CreateCourseByCopyFunction, CreateCourseListByCopyFunction, CreateProgramByCopyFunction, CreateSubProgramByCopyFunction

public abstract class AbstractCreateProgramItemByCopyFunction
extends AbstractCreateODFContentByCopyFunction

OSWorkflow function to create a program item by copy of another

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.plugins.workflow.EnhancedFunction

EnhancedFunction.FunctionArgument

Field Summary

Fields inherited from class org.ametys.odf.workflow.copy.AbstractCreateODFContentByCopyFunction

_odfHelper, PARENT_KEY

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_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
AbstractCreateProgramItemByCopyFunction()

Method Summary

Modifier and Type	Method	Description
protected SynchronizableValue	_buildParentSynchronizableValue(Content parent)	Get the parent attribute synchronizable value.
protected abstract Set<String>	_getChildrenReferencesName()	Get the attributes names holding the children relations between the content to create and its children
protected void	_populateAdditionalData(Map transientVars, ModifiableContent content)	Populate the content.
protected Map<String,Object>	getAdditionalCopyMap(Map transientVars, Content baseContent, String viewName, String fallbackViewName)	Get an additional copy map, if any.

Methods inherited from class org.ametys.odf.workflow.copy.AbstractCreateODFContentByCopyFunction

_createContent, _getContentNamePrefix, _getContentRoot, _getParent, _getParentAttributeName, _isCompatibleParent, processValues, service

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

execute, getBaseContentForCopy

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

_eventParamsForContentAdded, _getDefaultNameComputationMode, _getNameComputationMode, _getNonNullVar, _getObjectType, _getSubContentRoot, _initWorkflow, _isMultilingual, _notifyContentAdded, _populateContent, _setTitle, 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

Constructor Details

AbstractCreateProgramItemByCopyFunction

public AbstractCreateProgramItemByCopyFunction()

Method Details

getAdditionalCopyMap

protected Map<String,Object> getAdditionalCopyMap(Map transientVars,
 Content baseContent,
 String viewName,
 String fallbackViewName)
                                           throws com.opensymphony.workflow.WorkflowException

Description copied from class: CreateContentByCopyFunction

Get an additional copy map, if any. It allows subclasses to provide additional data to copy. This map is concatenated to the initial copy map.

Overrides:

getAdditionalCopyMap in class CreateContentByCopyFunction

Parameters:

transientVars - the workflow parameters

baseContent - the source content to be copied

viewName - the view name

fallbackViewName - the fallback view name, if required view does not exist

Returns:

the additional copy map, or null if none.

Throws:

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

_buildParentSynchronizableValue

protected SynchronizableValue _buildParentSynchronizableValue(Content parent)

Description copied from class: AbstractCreateODFContentByCopyFunction

Get the parent attribute synchronizable value.

Specified by:

_buildParentSynchronizableValue in class AbstractCreateODFContentByCopyFunction

Parameters:

parent - The parent

Returns:

a synchronizable value

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

_getChildrenReferencesName

protected abstract Set<String> _getChildrenReferencesName()

Get the attributes names holding the children relations between the content to create and its children

Returns:

the attributes names