Package org.silverpeas.core.calendar
Interface Occurrence
-
- All Superinterfaces:
Plannable
- All Known Implementing Classes:
CalendarEventOccurrence
public interface Occurrence extends Plannable
An instance of a plannable object occurring in the timeline of a calendar.- Author:
- mmoquillon
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Temporal
getEndDate()
The end date or datetime of the occurrence.String
getId()
Gets the unique identifier of this occurrence of an object planned in a calendar.Temporal
getStartDate()
The start date or datetime of the occurrence.
-
-
-
Method Detail
-
getId
String getId()
Gets the unique identifier of this occurrence of an object planned in a calendar.- Returns:
- the unique identifier of this occurrence.
-
getStartDate
Temporal getStartDate()
The start date or datetime of the occurrence. It is the inclusive lower bound of the period into which this occurrence occurs in a calendar. If this occurrence is on all days, then gets a date. Otherwise, gets a datetime in UTC/Greenwich. on the timeline.- Returns:
- a temporal instance of
LocalDate
if the occurrence takes all the day or a temporal instance ofOffsetDateTime
in UTC/Greenwich otherwise.
-
getEndDate
Temporal getEndDate()
The end date or datetime of the occurrence. It is the exclusive upper bound of the period into which this occurrence occurs in a calendar. If this occurrence is on all days, then gets a date. Otherwise, gets a datetime in UTC/Greenwich.- Returns:
- a temporal instance of
LocalDate
if the occurrence takes all the day or a temporal instance ofOffsetDateTime
in UTC/Greenwich otherwise.
-
-