Package org.ametys.plugins.workspaces.calendars.workflow

Class AddEventFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.plugins.workspaces.workflow.AbstractNodeWorkflowComponent

org.ametys.plugins.workspaces.calendars.workflow.AddEventFunction

All Implemented Interfaces:

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

Direct Known Subclasses:

EditEventFunction

public class AddEventFunction
extends AbstractNodeWorkflowComponent
implements EnhancedFunction

Action for adding a calendar event

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 CalendarDAO	_calendarDAO	Calendar manager for workspaces
protected CalendarEventDAO	_calendarEventDAO	Calendar event manager for workspaces
protected CalendarEventJSONHelper	_calendarEventJSONHelper	The tasks list JSON helper
protected CurrentUserProvider	_currentUserProvider	The current user provider.
protected ObservationManager	_observationManager	Observer manager.
protected ProjectTagsDAO	_projectTagsDAO	The project tags DAO
protected AmetysObjectResolver	_resolver	The Ametys object resolver

Fields inherited from class org.ametys.plugins.workspaces.workflow.AbstractNodeWorkflowComponent

EXPLORERNODE_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
AddEventFunction()

Method Summary

Modifier and Type	Method	Description
protected void	_initializeWorkflow(ModifiableCalendarEvent event, Map transientVars, Map<String,Object> jsParameters)	Initialize the workflow store
protected void	_notifyListeners(CalendarEvent event)	Notify listeners that the event has been created
protected void	_setEventData(ModifiableCalendarEvent event, Map transientVars, Map<String,Object> jsParameters)	Set the event data
void	execute(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)
EnhancedFunction.FunctionType	getFunctionExecType()	Return the type for the function
I18nizableText	getLabel()	Get the label for this function
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.plugins.workspaces.workflow.AbstractNodeWorkflowComponent

getExplorerNode

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

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_observationManager

protected ObservationManager _observationManager

Observer manager.

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider.

_projectTagsDAO

protected ProjectTagsDAO _projectTagsDAO

The project tags DAO

_calendarDAO

protected CalendarDAO _calendarDAO

Calendar manager for workspaces

_calendarEventDAO

protected CalendarEventDAO _calendarEventDAO

Calendar event manager for workspaces

_calendarEventJSONHelper

protected CalendarEventJSONHelper _calendarEventJSONHelper

The tasks list JSON helper

Constructor Details

AddEventFunction

public AddEventFunction()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractWorkflowComponent

Throws:

ServiceException

execute

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

Specified by:

execute in interface com.opensymphony.workflow.FunctionProvider

Throws:

com.opensymphony.workflow.WorkflowException

_initializeWorkflow

protected void _initializeWorkflow(ModifiableCalendarEvent event,
 Map transientVars,
 Map<String,Object> jsParameters)
                            throws com.opensymphony.workflow.WorkflowException

Initialize the workflow store

Parameters:

event - The event

transientVars - The transient variables

jsParameters - The JS parameters

Throws:

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

_setEventData

protected void _setEventData(ModifiableCalendarEvent event,
 Map transientVars,
 Map<String,Object> jsParameters)
                      throws com.opensymphony.workflow.WorkflowException

Set the event data

Parameters:

event - The event

transientVars - The transient variables

jsParameters - The JS parameters

Throws:

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

_notifyListeners

protected void _notifyListeners(CalendarEvent event)

Notify listeners that the event has been created

Parameters:

event - The created event

getFunctionExecType

public EnhancedFunction.FunctionType getFunctionExecType()

Description copied from interface: EnhancedFunction

Return the type for the function

Specified by:

getFunctionExecType in interface EnhancedFunction

Returns:

the type 's code

getLabel

public I18nizableText getLabel()

Description copied from interface: EnhancedFunction

Get the label for this function

Specified by:

getLabel in interface EnhancedFunction

Returns:

the label