Package org.ametys.plugins.workspaces.calendars

Interface Calendar

All Known Subinterfaces:

ModifiableCalendar, WorkflowAwareCalendar

All Known Implementing Classes:

JCRCalendar, TaskCalendar

public interface Calendar

Calendar Interface

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Calendar.CalendarVisibility	Enumeration of calendar visiblity

Method Summary

Modifier and Type	Method	Description
List<CalendarEvent>	getAllEvents()	Get all events of the calendar
List<Calendar>	getChildCalendars()	Get the child calendars
String	getColor()	Get the color of the calendar
String	getDescription()	Get the description of the calendar
Map<CalendarEvent,List<CalendarEventOccurrence>>	getEvents(ZonedDateTime startDate, ZonedDateTime endDate)	Get the events and its occurrences of the calendar between two dates
String	getIcsUrlToken()	Get the token used by the ICS public URL
String	getId()	Get the id of the calendar
String	getName()	Get the name of the calendar
Project	getProject()	Get the project
String	getTemplateDescription()	Get the template description of the calendar
Calendar.CalendarVisibility	getVisibility()	Get the calendar visibility

Method Details

getId

String getId()

Get the id of the calendar

Returns:

the id

getName

String getName()

Get the name of the calendar

Returns:

the name

getDescription

String getDescription()

Get the description of the calendar

Returns:

the description

getProject

Project getProject()

Get the project

Returns:

the project

getColor

String getColor()

Get the color of the calendar

Returns:

the color of the calendar

getVisibility

Calendar.CalendarVisibility getVisibility()

Get the calendar visibility

Returns:

the calendar visibility

getTemplateDescription

String getTemplateDescription()

Get the template description of the calendar

Returns:

the template description of the calendar

getChildCalendars

List<Calendar> getChildCalendars()

Get the child calendars

Returns:

the child calendars

getAllEvents

List<CalendarEvent> getAllEvents()

Get all events of the calendar

Returns:

the list of events

getEvents

Map<CalendarEvent,List<CalendarEventOccurrence>> getEvents(ZonedDateTime startDate,
 ZonedDateTime endDate)

Get the events and its occurrences of the calendar between two dates

Parameters:

startDate - Begin date

endDate - End date

Returns:

the map of events and its occurrences

getIcsUrlToken

String getIcsUrlToken()

Get the token used by the ICS public URL

Returns:

The token, or null if no token exists for the calendar