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

public class CreateCourseFunction
extends AbstractCreateODFProgramItemFunction

OSWorkflow function for creating a Course content

Field Summary

Fields

Modifier and Type	Field	Description
protected ShareableCourseHelper	_shareableCourseHelper	The shareable course helper
static String	CONTENT_NAME_PREFIX	Content name prefix for programs
static 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, 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
CreateCourseFunction()

Method Summary

Modifier and Type	Method	Description
protected String	_getContentNamePrefix()	Get the prefix for content name
protected String	_getNodeType()	Get the content node type
protected void	_populateAdditionalData(Map transientVars, ModifiableContent content)	Populate the content.
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, _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

Field Detail

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 Detail

CreateCourseFunction

public CreateCourseFunction()

Method Detail

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

_getNodeType

protected String _getNodeType()

Description copied from class: AbstractCreateODFContentFunction

Get the content node type

Specified by:

_getNodeType in class AbstractCreateODFContentFunction

Returns:

the content node type

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