Package org.ametys.odf.workflow

Class CreateCoursePartFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.CreateContentFunction

org.ametys.odf.workflow.AbstractCreateODFContentFunction

org.ametys.odf.workflow.CreateCoursePartFunction

All Implemented Interfaces:

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

public class CreateCoursePartFunction
extends AbstractCreateODFContentFunction

OSWorkflow function for creating a CoursePart content

Nested Class Summary

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

EnhancedFunction.FunctionArgument

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_NAME_PREFIX	Content name prefix for programs
static final String	COURSE_HOLDER_KEY	Constant for storing the catalog name to use into the transient variables map.

Fields inherited from class org.ametys.odf.workflow.AbstractCreateODFContentFunction

_odfHelper, CONTENT_CATALOG_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, 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
CreateCoursePartFunction()

Method Summary

Modifier and Type	Method	Description
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 void	_populateAdditionalData(Map transientVars, ModifiableContent content)	Populate the content.

Methods inherited from class org.ametys.odf.workflow.AbstractCreateODFContentFunction

_createContent, _getContentRoot, execute, service

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

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

Field Details

CONTENT_NAME_PREFIX

public static final String CONTENT_NAME_PREFIX

Content name prefix for programs

See Also:

• Constant Field Values

COURSE_HOLDER_KEY

public static final String COURSE_HOLDER_KEY

Constant for storing the catalog name to use into the transient variables map.

Constructor Details

CreateCoursePartFunction

public CreateCoursePartFunction()

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.

_getContentNamePrefix

protected String _getContentNamePrefix()

Description copied from class: AbstractCreateODFContentFunction

Get the prefix for content name

Specified by:

_getContentNamePrefix in class AbstractCreateODFContentFunction

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