Package org.ametys.plugins.workspaces.calendars.events

Class CalendarEventDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.AbstractWorkspaceDAO

org.ametys.plugins.workspaces.calendars.AbstractCalendarDAO

org.ametys.plugins.workspaces.calendars.events.CalendarEventDAO

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class CalendarEventDAO
extends AbstractCalendarDAO

Calendar event DAO

Field Summary

Fields

Modifier and Type	Field	Description
protected CalendarDAO	_calendarDAO	The calendar DAO
protected CalendarEventJSONHelper	_calendarEventJSONHelper	The tasks list JSON helper
static final String	ROLE	Avalon Role

Fields inherited from class org.ametys.plugins.workspaces.calendars.AbstractCalendarDAO

_calendarColors, _explorerResourcesDAO, _messagingConnectorCalendarManager, RIGHTS_BOOK_RESOURCE, RIGHTS_CALENDAR_ADD, RIGHTS_CALENDAR_DELETE, RIGHTS_CALENDAR_EDIT, RIGHTS_EVENT_ADD, RIGHTS_EVENT_DELETE, RIGHTS_EVENT_DELETE_OWN, RIGHTS_EVENT_EDIT, RIGHTS_EXPORT_ICS_LINK, RIGHTS_HANDLE_RESOURCE, RIGHTS_OWNED_EVENT_DELETE

Fields inherited from class org.ametys.plugins.workspaces.AbstractWorkspaceDAO

_context, _currentUserProvider, _observationManager, _projectManager, _projectRightHelper, _projectTagsDAO, _resolver, _richTextTransformer, _rightManager, _userManager, _workflowHelper, _workflowProvider, _workspaceHelper, _workspaceModuleEP

Constructor Summary

Constructors

Constructor	Description
CalendarEventDAO()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	addEvent(Map<String,Object> parameters, String calendarViewStartDateAsStr, String calendarViewEndDateAsStr)	Add an event and return it.
Map<String,Object>	deleteEvent(String id, String occurrence, String choice)	Delete an event
Map<String,Object>	doWorkflowEventAction(Map<String,Object> parameters)	Do an event workflow action
Map<String,Object>	editEvent(Map<String,Object> parameters, String calendarViewStartDateAsStr, String calendarViewEndDateAsStr)	Edit an event
CalendarEvent	getCalenderEventById(String eventId)	Get an event by id
Map<String,Object>	getEventByID(String id)	Get an event by id
List<Map<String,Object>>	getEvents(String startDateAsStr, String endDateAsStr)	Get the events between two dates
List<CalendarEvent>	getEvents(ZonedDateTime startDate, ZonedDateTime endDate)	Get the events between two dates
void	move(JCRCalendarEvent event, JCRCalendar parent)	Move a event to another calendar
void	service(ServiceManager manager)

Methods inherited from class org.ametys.plugins.workspaces.AbstractWorkspaceDAO

_checkReadAccess, _checkUserReadingRights, _checkUserRights, _handleTags, _hasAfterSubComments, _setAttachments, answerComment, contextualize, createComment, deleteComment, editComment, getProjectName, getSitemapLanguage, getSiteName, likeOrUnlikeComment

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ROLE

public static final String ROLE

Avalon Role

_calendarEventJSONHelper

protected CalendarEventJSONHelper _calendarEventJSONHelper

The tasks list JSON helper

_calendarDAO

protected CalendarDAO _calendarDAO

The calendar DAO

Constructor Details

CalendarEventDAO

public CalendarEventDAO()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractCalendarDAO

Throws:

ServiceException

getEvents

public List<Map<String,Object>> getEvents(String startDateAsStr,
 String endDateAsStr)

Get the events between two dates

Parameters:

startDateAsStr - The start date.

endDateAsStr - The end date.

Returns:

the events between two dates

getEvents

public List<CalendarEvent> getEvents(ZonedDateTime startDate,
 ZonedDateTime endDate)

Get the events between two dates

Parameters:

startDate - Begin date

endDate - End date

Returns:

the list of events

deleteEvent

public Map<String,Object> deleteEvent(String id,
 String occurrence,
 String choice)

Delete an event

Parameters:

id - The id of the event

occurrence - a string representing the occurrence date (ISO format).

choice - The type of modification

Returns:

The result map with id, parent id and message keys

addEvent

public Map<String,Object> addEvent(Map<String,Object> parameters,
 String calendarViewStartDateAsStr,
 String calendarViewEndDateAsStr)
                            throws com.opensymphony.workflow.WorkflowException

Add an event and return it. Use the calendar view dates to compute occurrences between those dates.

Parameters:

parameters - The map of parameters to perform the action

calendarViewStartDateAsStr - The calendar view start date, compute occurrences after this date.

calendarViewEndDateAsStr - The calendar view end date, compute occurrences before this date.

Returns:

The map of results populated by the underlying workflow action

Throws:

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

editEvent

public Map<String,Object> editEvent(Map<String,Object> parameters,
 String calendarViewStartDateAsStr,
 String calendarViewEndDateAsStr)
                             throws com.opensymphony.workflow.WorkflowException

Edit an event

Parameters:

parameters - The map of parameters to perform the action

calendarViewStartDateAsStr - The calendar view start date, compute occurrences after this date.

calendarViewEndDateAsStr - The calendar view end date, compute occurrences before this date.

Returns:

The map of results populated by the underlying workflow action

Throws:

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

move

public void move(JCRCalendarEvent event,
 JCRCalendar parent)
          throws AmetysRepositoryException

Move a event to another calendar

Parameters:

event - The event to move

parent - The new parent calendar

Throws:

AmetysRepositoryException - if an error occurred while moving

doWorkflowEventAction

public Map<String,Object> doWorkflowEventAction(Map<String,Object> parameters)
                                         throws com.opensymphony.workflow.WorkflowException

Do an event workflow action

Parameters:

parameters - The map of action parameters

Returns:

The map of results populated by the workflow action

Throws:

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

getEventByID

public Map<String,Object> getEventByID(String id)

Get an event by id

Parameters:

id - The id of the event

Returns:

The event as a JSON map

getCalenderEventById

public CalendarEvent getCalenderEventById(String eventId)

Get an event by id

Parameters:

eventId - The id of the event

Returns:

The event