Package org.ametys.odf.workflow.copy

Class CreateCoursePartByCopyFunction

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

All Implemented Interfaces:

com.opensymphony.workflow.FunctionProvider, LogEnabled, Serviceable

public class CreateCoursePartByCopyFunction
extends AbstractCreateODFContentByCopyFunction

OSWorkflow function to create a course part by copy of another

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COURSE_HOLDER_KEY	Constant for storing the course holder

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

Method Summary

Modifier and Type	Method	Description
protected SynchronizableValue	_buildParentSynchronizableValue(Content parent)	Get the parent attribute synchronizable value.
protected String	_getContentNamePrefix()	Get the prefix for content name
protected NameHelper.NameComputationMode	_getDefaultNameComputationMode()	Define the default computation mode
protected String	_getObjectType(Map transientVars, Map args)	Return the type of the object to be created.
protected Content	_getParent(Map transientVars)	Get the parent content if exists.
protected String	_getParentAttributeName(Content parent)	Get the parent attribute name.
protected boolean	_isCompatibleParent(Content parent)	Check if the parent is compatible
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, _getContentRoot, processValues, service

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

execute, getBaseContentForCopy

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

_eventParamsForContentAdded, _getNameComputationMode, _getNonNullVar, _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

Field Details

COURSE_HOLDER_KEY

public static final String COURSE_HOLDER_KEY

Constant for storing the course holder

See Also:

• Constant Field Values

Constructor Details

CreateCoursePartByCopyFunction

public CreateCoursePartByCopyFunction()

Method Details

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

getAdditionalCopyMap

protected Map<String,Object> getAdditionalCopyMap(Map transientVars,
 Content baseContent,
 String viewName,
 String fallbackViewName)

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.

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

_getDefaultNameComputationMode

protected NameHelper.NameComputationMode _getDefaultNameComputationMode()

Description copied from class: CreateContentFunction

Define the default computation mode

Overrides:

_getDefaultNameComputationMode in class CreateContentFunction

Returns:

the default computation mode

_getParent

protected Content _getParent(Map transientVars)

Description copied from class: AbstractCreateODFContentByCopyFunction

Get the parent content if exists.

Overrides:

_getParent in class AbstractCreateODFContentByCopyFunction

Parameters:

transientVars - The transient vars

Returns:

the parent content (may be not compatible at this stage)

_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

_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