Package org.ametys.odf.workflow

Class AbstractCoursePartFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.AbstractContentFunction

org.ametys.odf.workflow.AbstractCoursePartFunction

All Implemented Interfaces:

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

Direct Known Subclasses:

MoveLiveTagOnCoursePartFunction, UnpublishCoursePartFunction

public abstract class AbstractCoursePartFunction
extends AbstractContentFunction

Do action on CoursePart of given course.

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 ContentWorkflowHelper	_contentWorkflowHelper	Content workflow helper
protected AmetysObjectResolver	_resolver	Ametys object resolver

Fields inherited from class org.ametys.cms.workflow.AbstractContentFunction

_observationManager, _workflowProvider, EVENT_TO_NOTIFY_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
AbstractCoursePartFunction()

Method Summary

Modifier and Type	Method	Description
protected abstract Integer	_getCoursePartActionId()	Get the id of the action to do for course part
void	execute(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)
EnhancedFunction.FunctionType	getFunctionExecType()	Return the type for the function
void	service(ServiceManager smanager)

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

_addLabel, _addLockToken, _createVersion, _getDefaultEvent, _notify, _setCurrentStepId, _setCurrentStepIdAndNotify, initialize

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, getLabel, getVisibilities

Field Details

_resolver

protected AmetysObjectResolver _resolver

Ametys object resolver

_contentWorkflowHelper

protected ContentWorkflowHelper _contentWorkflowHelper

Content workflow helper

Constructor Details

AbstractCoursePartFunction

public AbstractCoursePartFunction()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractContentWorkflowComponent

Throws:

ServiceException

execute

public void execute(Map transientVars,
 Map args,
 com.opensymphony.module.propertyset.PropertySet ps)
             throws com.opensymphony.workflow.WorkflowException

Throws:

com.opensymphony.workflow.WorkflowException

getFunctionExecType

public EnhancedFunction.FunctionType getFunctionExecType()

Description copied from interface: EnhancedFunction

Return the type for the function

Returns:

the type 's code

_getCoursePartActionId

protected abstract Integer _getCoursePartActionId()

Get the id of the action to do for course part

Returns:

the id of the action to do for course part