Package org.ametys.odf.workflow.copy

Class CreateCourseByCopyFunction

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

org.ametys.odf.workflow.copy.CreateCourseByCopyFunction

All Implemented Interfaces:

com.opensymphony.workflow.FunctionProvider, LogEnabled, Serviceable

public class CreateCourseByCopyFunction
extends AbstractCreateProgramItemByCopyFunction

OSWorkflow function to create a course by copy of another

Field Summary

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

PARENT_KEY

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

_odfHelper

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, 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
CreateCourseByCopyFunction()

Method Summary

Modifier and Type	Method	Description
protected Set<String>	_getChildReferenceMetadataName()	Get the metadata name holding the child relation between the content to create and its children
protected String	_getContentNamePrefix()	Get the prefix for content name
protected String	_getNodeType()	Get the content node type
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.AbstractCreateProgramItemByCopyFunction

_populateAdditionalData, processValues

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

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

CreateCourseByCopyFunction

public CreateCourseByCopyFunction()

Method Detail

_getContentNamePrefix

protected String _getContentNamePrefix()

Description copied from class: AbstractCreateODFContentByCopyFunction

Get the prefix for content name

Specified by:

_getContentNamePrefix in class AbstractCreateODFContentByCopyFunction

Returns:

the prefix

_getNodeType

protected String _getNodeType()

Description copied from class: AbstractCreateODFContentByCopyFunction

Get the content node type

Specified by:

_getNodeType in class AbstractCreateODFContentByCopyFunction

Returns:

the content node type

_getChildReferenceMetadataName

protected Set<String> _getChildReferenceMetadataName()

Description copied from class: AbstractCreateProgramItemByCopyFunction

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

Specified by:

_getChildReferenceMetadataName in class AbstractCreateProgramItemByCopyFunction

Returns:

the metadata name

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 AbstractCreateProgramItemByCopyFunction

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