Package org.ametys.odf.workflow

Class CreateCourseFunction

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

org.ametys.odf.workflow.CreateCourseFunction

All Implemented Interfaces:

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

public class CreateCourseFunction
extends AbstractCreateODFProgramItemFunction

OSWorkflow function for creating a Course content

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

AbstractWorkflowComponent.ConditionFailure

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

EnhancedFunction.FunctionType

Field Summary

Fields

Modifier and Type	Field	Description
protected ShareableCourseHelper	_shareableCourseHelper	The shareable course helper
static final String	CONTENT_NAME_PREFIX	Content name prefix for programs
static final String	COURSE_LIST_ID_KEY	Constant for storing the parent course list id 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_CONTEXT_VALUE, ROOT_CONTENT_PATH_KEY

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_VALIDATION_KEY

Constructor Summary

Constructors

Constructor	Description
CreateCourseFunction()

Method Summary

Modifier and Type	Method	Description
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 void	_populateAdditionalData(Map transientVars, ModifiableContent content)	Populate the content.
I18nizableText	getLabel()	Get the label for this function
void	service(ServiceManager manager)

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

_createContent, _getContentRoot, execute

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

_eventParamsForContentAdded, _getDefaultNameComputationMode, _getNameComputationMode, _getNonNullVar, _initWorkflow, _isMultilingual, _notifyContentAdded, _populateContent, _setTitle, getFunctionExecType, 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

Methods inherited from interface org.ametys.plugins.workflow.EnhancedFunction

getArguments, getFullLabel, getVisibilities

Field Details

COURSE_LIST_ID_KEY

public static final String COURSE_LIST_ID_KEY

Constant for storing the parent course list id to use into the transient variables map.

CONTENT_NAME_PREFIX

public static final String CONTENT_NAME_PREFIX

Content name prefix for programs

See Also:

• Constant Field Values

_shareableCourseHelper

protected ShareableCourseHelper _shareableCourseHelper

The shareable course helper

Constructor Details

CreateCourseFunction

public CreateCourseFunction()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractCreateODFContentFunction

Throws:

ServiceException

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

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

Parameters:

transientVars - the transient variables.

content - the content.

Throws:

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

getLabel

public I18nizableText getLabel()

Description copied from interface: EnhancedFunction

Get the label for this function

Specified by:

getLabel in interface EnhancedFunction

Overrides:

getLabel in class CreateContentFunction

Returns:

the label