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

Class EditEventFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.plugins.workspaces.workflow.AbstractNodeWorkflowComponent

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

org.ametys.plugins.workspaces.calendars.workflow.EditEventFunction

All Implemented Interfaces:

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

public class EditEventFunction
extends AddEventFunction

Action for editing a calendar event

Nested Class Summary

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

EnhancedFunction.FunctionArgument

Field Summary

Fields

Modifier and Type	Field	Description
protected WorkflowProvider	_workflowProvider	Workflow provider

Fields inherited from class org.ametys.plugins.workspaces.calendars.workflow.AddEventFunction

_calendarDAO, _calendarEventDAO, _calendarEventJSONHelper, _currentUserProvider, _observationManager, _projectTagsDAO, _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_ERRORS_KEY, WORKFLOW_WARNS_KEY

Constructor Summary

Constructors

Constructor	Description
EditEventFunction()

Method Summary

Modifier and Type	Method	Description
protected ZonedDateTime[]	_computeEventDates(CalendarEvent event, Map<String,Object> jsParameters)	Compute the start date and end date of the event from the edited occurrence
protected void	_createEventFromOccurrence(CalendarEvent initialEvent, Calendar parentCalendar, Map transientVars, Map<String,Object> jsParameters)	Create a new event from the occurrence of a event
protected void	_excludeOccurrence(ModifiableCalendarEvent event, ZonedDateTime occurrenceDate)	Exclude a occurrence of a event
protected void	_notifyListeners(CalendarEvent event)	Notify listeners that the event has been updated
void	execute(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)
List<EnhancedFunction.FunctionArgument>	getArguments()	Get the list of accepted arguments for this function
I18nizableText	getDescription(Map<String,String> args)	Get the function descriptions depending on arguments values
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.plugins.workspaces.calendars.workflow.AddEventFunction

_initializeWorkflow, _setEventData

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

Field Details

_workflowProvider

protected WorkflowProvider _workflowProvider

Workflow provider

Constructor Details

EditEventFunction

public EditEventFunction()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AddEventFunction

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

Overrides:

execute in class AddEventFunction

Throws:

com.opensymphony.workflow.WorkflowException

_createEventFromOccurrence

protected void _createEventFromOccurrence(CalendarEvent initialEvent,
 Calendar parentCalendar,
 Map transientVars,
 Map<String,Object> jsParameters)

Create a new event from the occurrence of a event

Parameters:

initialEvent - The initial event

parentCalendar - The parent calendar

transientVars - The transient variable

jsParameters - The JS parameters

_excludeOccurrence

protected void _excludeOccurrence(ModifiableCalendarEvent event,
 ZonedDateTime occurrenceDate)

Exclude a occurrence of a event

Parameters:

event - The event

occurrenceDate - The date to exclude

_computeEventDates

protected ZonedDateTime[] _computeEventDates(CalendarEvent event,
 Map<String,Object> jsParameters)

Compute the start date and end date of the event from the edited occurrence

Parameters:

event - The event

jsParameters - The JS parameters

Returns:

an array with computed start and end dates

_notifyListeners

protected void _notifyListeners(CalendarEvent event)

Notify listeners that the event has been updated

Overrides:

_notifyListeners in class AddEventFunction

Parameters:

event - The updated event

getArguments

public List<EnhancedFunction.FunctionArgument> getArguments()

Description copied from interface: EnhancedFunction

Get the list of accepted arguments for this function

Specified by:

getArguments in interface EnhancedFunction

Overrides:

getArguments in class AddEventFunction

Returns:

a List of argument names and associated description

getDescription

public I18nizableText getDescription(Map<String,String> args)

Description copied from interface: EnhancedFunction

Get the function descriptions depending on arguments values

Specified by:

getDescription in interface EnhancedFunction

Overrides:

getDescription in class AddEventFunction

Parameters:

args - a map of the arguments with their values in current workflow

Returns:

a description to display in workflow editor vue