Calendar (Ametys 4.5.x - API)

All Superinterfaces:

AmetysObject, ExplorerNode, TraversableAmetysObject

All Known Subinterfaces:

ModifiableCalendar

All Known Implementing Classes:

JCRCalendar
```
public interface Calendar
extends ExplorerNode, TraversableAmetysObject
```
Calendar Interface

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class Calendar.CalendarVisibility
Enumeration of calendar visiblity

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getColor()`	Get the color 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`	`getTemplateDescription()`	Get the template description of the calendar
`Calendar.CalendarVisibility`	`getVisibility()`	Get the calendar visibility
`String`	`getWorkflowName()`	Get the name of the workflow of the calendar

Methods inherited from interface org.ametys.plugins.repository.AmetysObject
equals, getId, getName, getParent, getParentPath, getPath, hashCode

Methods inherited from interface org.ametys.plugins.explorer.ExplorerNode
getApplicationId, getDescription, getExplorerPath, getIconCls, hasChildExplorerNodes

Methods inherited from interface org.ametys.plugins.repository.TraversableAmetysObject
getChild, getChildAt, getChildPosition, getChildren, hasChild

- Method Detail
  - 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
  - getWorkflowName
```
String getWorkflowName()
```
    Get the name of the workflow of the calendar
    
    Returns:
    
    the name of the workflow of the calendar
  - getTemplateDescription
```
String getTemplateDescription()
```
    Get the template description of the calendar
    
    Returns:
    
    the template description of the calendar
  - 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