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, EnhancedFunction, LogEnabled, Serviceable

public class CreateCourseByCopyFunction
extends AbstractCreateProgramItemByCopyFunction

OSWorkflow function to create a course 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
CreateCourseByCopyFunction()

Method Summary

Modifier and Type	Method	Description
protected Set<String>	_getChildrenReferencesName()	Get the attributes names holding the children relations between the content to create and its children
protected String	_getContentNamePrefix()	Get the prefix for content name
protected String	_getObjectType(Map transientVars, Map args)	Return the type of the object to be created.
protected String	_getParentAttributeName(Content parent)	Get the parent attribute name.
protected boolean	_isCompatibleParent(Content parent)	Check if the parent is compatible
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

_buildParentSynchronizableValue, _populateAdditionalData

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

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

CreateCourseByCopyFunction

public CreateCourseByCopyFunction()

Method Details

_getContentNamePrefix

protected String _getContentNamePrefix()

Description copied from class: AbstractCreateODFContentByCopyFunction

Get the prefix for content name

Specified by:

_getContentNamePrefix in class AbstractCreateODFContentByCopyFunction

Returns:

the prefix

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

_getChildrenReferencesName

protected Set<String> _getChildrenReferencesName()

Description copied from class: AbstractCreateProgramItemByCopyFunction

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

Specified by:

_getChildrenReferencesName in class AbstractCreateProgramItemByCopyFunction

Returns:

the attributes names

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

_isCompatibleParent

protected boolean _isCompatibleParent(Content parent)

Description copied from class: AbstractCreateODFContentByCopyFunction

Check if the parent is compatible

Specified by:

_isCompatibleParent in class AbstractCreateODFContentByCopyFunction

Parameters:

parent - The parent

Returns:

true if the parent is compatible

_getParentAttributeName

protected String _getParentAttributeName(Content parent)

Description copied from class: AbstractCreateODFContentByCopyFunction

Get the parent attribute name.

Specified by:

_getParentAttributeName in class AbstractCreateODFContentByCopyFunction

Parameters:

parent - The parent

Returns:

the parent attribute name