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, 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

Field Summary

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

_odfHelper

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

_copyContentMetadataHelper, _cTypesHelper, _i18nUtils, BASE_CONTENT_ID, BASE_CONTENT_KEY, COPY_FALLBACK_METADATASET_NAME, COPY_MAP_KEY, COPY_METADATASET_NAME, COPY_METADATASET_TYPE, COPY_REPORT_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, PARENT_CONTENT_ID_KEY, PARENT_CONTENT_METADATA_PATH_KEY

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

_contentHelper, CONTENT_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 Map<String,Object>	_buildCopyMap(Map transientVars, Content baseContent, String metadataSetName, String fallbackMetadataSetName, String metadataSetType)	Get the builded copy map
protected abstract Set<String>	_getChildReferenceMetadataName()	Get the metadata name holding the child relation between the content to create and its children
protected void	_populateAdditionalData(Map transientVars, ModifiableContent content)	Populate the content.

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

_createContent, _getContentNamePrefix, _getContentRoot, _getNodeType, service

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

execute, getBaseContentForCopy

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

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

AbstractCreateProgramItemByCopyFunction

public AbstractCreateProgramItemByCopyFunction()

Method Detail

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

Parameters:

transientVars - the transient variables.

content - the content.

Throws:

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

_buildCopyMap

protected Map<String,Object> _buildCopyMap(Map transientVars,
                                                 Content baseContent,
                                                 String metadataSetName,
                                                 String fallbackMetadataSetName,
                                                 String metadataSetType)

Description copied from class: CreateContentByCopyFunction

Get the builded copy map

Overrides:

_buildCopyMap in class CreateContentByCopyFunction

Parameters:

transientVars - the vars

baseContent - the base content to be copied

metadataSetName - the metadata set name

fallbackMetadataSetName - the fallbacl metadata set name, if required metadata set does not exist

metadataSetType - the metadata set type

Returns:

the builded copy map

_getChildReferenceMetadataName

protected abstract Set<String> _getChildReferenceMetadataName()

Get the metadata name holding the child relation between the content to create and its children

Returns:

the metadata name