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

Interface CalendarEvent

All Superinterfaces:

AmetysObject, DataHolder, IndexableAmetysObject, IndexableDataHolder, ModelAwareAmetysObject, ModelAwareDataHolder, TagAwareAmetysObject, TaggableAmetysObject

All Known Subinterfaces:

ModifiableCalendarEvent

All Known Implementing Classes:

JCRCalendarEvent, TaskCalendarEvent

public interface CalendarEvent
extends TaggableAmetysObject, IndexableAmetysObject

Calendar event interface

Field Summary

Fields inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder

ALTERNATIVE_SUFFIX, STATUS_SUFFIX

Method Summary

Modifier and Type	Method	Description
Calendar	getCalendar()	Get the calendar holding the event
ZonedDateTime	getCreationDate()	Retrieves the creation date.
UserIdentity	getCreator()	Retrieves the the creator.
String	getDescription()	Get the description of the event
ZonedDateTime	getEndDate()	Get the date of the end of the event
List<ZonedDateTime>	getExcludedOccurences()	Retrieves the list of excluded event date.
Optional<CalendarEventOccurrence>	getFirstOccurrence(ZonedDateTime date)	Retrieves the start date of the first Event which end after the date
Boolean	getFullDay()	Get if the event last all the day
UserIdentity	getLastContributor()	Retrieves the last contributor.
ZonedDateTime	getLastModified()	Retrieves the last modification date.
String	getLocation()	Get the location of the event
Optional<CalendarEventOccurrence>	getNextOccurrence(CalendarEventOccurrence occurrence)	Retrieves the date of the next event after the date
List<CalendarEventOccurrence>	getOccurrences(ZonedDateTime startDate, ZonedDateTime endDate)	Retrieves the list of all event date between startDate and endDate.
UserIdentity	getOrganiser()	Retrieves the organiser.
EventRecurrenceTypeEnum	getRecurrenceType()	Retrieves the recurrence type.
ZonedDateTime	getRepeatUntil()	Retrieves the upper bound of the recurrence This bound is inclusive, meaning that if it is synchronized (ie on a recurrence day at the event starting hour) with the recurrence, it represents the starting date of the last occurrence
List<String>	getResources()	Retrieves the resource list.
ZonedDateTime	getStartDate()	Get the date of the begin of the event
String	getTitle()	Get the title of the event
ZoneId	getZone()	Get the date zone of the event
Boolean	isRecurrent()	Retrieves if the event is recurrent.

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Methods inherited from interface org.ametys.plugins.repository.data.holder.DataHolder

copyTo, copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getRepositoryData, getValue, getValueOrDefault, hasValue, hasValueOrEmpty

Methods inherited from interface org.ametys.cms.data.ametysobject.IndexableAmetysObject

getSystemPropertyExtensionPoint, indexData, indexData

Methods inherited from interface org.ametys.cms.data.holder.IndexableDataHolder

getComposite, getExternalComposite, getExternalRepeater, getLocalComposite, getLocalRepeater, getParentDataHolder, getRepeater, getRootDataHolder

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModelAwareAmetysObject

getModel

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder

dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSONForEdition, dataToMap, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getDataNames, getDefinition, getDifferences, getDifferences, getDifferences, getDifferences, getExternalValue, getLocalValue, getModelItemTypeExtensionPoint, getStatus, getType, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, getValueWithMultiValuedPathSegments, hasDefinition, hasDifferences, hasDifferences, hasDifferences, hasDifferences, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, isMultiple, isMultiple

Methods inherited from interface org.ametys.plugins.repository.tag.TagAwareAmetysObject

getTags

Methods inherited from interface org.ametys.plugins.repository.tag.TaggableAmetysObject

tag, untag

Method Details

getTitle

String getTitle()

Get the title of the event

Returns:

the title of the event

getCalendar

Calendar getCalendar()

Get the calendar holding the event

Returns:

the calendar

getDescription

String getDescription()

Get the description of the event

Returns:

the description of the event

getLocation

String getLocation()

Get the location of the event

Returns:

the location of the event

getStartDate

ZonedDateTime getStartDate()

Get the date of the begin of the event

Returns:

the date of the event

getEndDate

ZonedDateTime getEndDate()

Get the date of the end of the event

Returns:

the date of the event

getZone

ZoneId getZone()

Get the date zone of the event

Returns:

the date zone of the event

getFullDay

Boolean getFullDay()

Get if the event last all the day

Returns:

true if the event last all the day

getCreator

UserIdentity getCreator()

Retrieves the the creator.

Returns:

the creator.

Throws:

AmetysRepositoryException - if an error occurs.

getCreationDate

ZonedDateTime getCreationDate()

Retrieves the creation date.

Returns:

the creation date.

Throws:

AmetysRepositoryException - if an error occurs.

getLastContributor

UserIdentity getLastContributor()

Retrieves the last contributor.

Returns:

the last contributor.

Throws:

AmetysRepositoryException - if an error occurs.

getLastModified

ZonedDateTime getLastModified()

Retrieves the last modification date.

Returns:

the last modification date.

Throws:

AmetysRepositoryException - if an error occurs.

getRecurrenceType

EventRecurrenceTypeEnum getRecurrenceType()

Retrieves the recurrence type.

Returns:

the recurrence type.

isRecurrent

Boolean isRecurrent()

Retrieves if the event is recurrent.

Returns:

true if the event is recurrent.

getRepeatUntil

ZonedDateTime getRepeatUntil()

Retrieves the upper bound of the recurrence This bound is inclusive, meaning that if it is synchronized (ie on a recurrence day at the event starting hour) with the recurrence, it represents the starting date of the last occurrence

Returns:

the last possible start instant of the recurrence.

getExcludedOccurences

List<ZonedDateTime> getExcludedOccurences()

Retrieves the list of excluded event date.

Returns:

the list of excluded event date as ZonedDateTime representing midnight in event timezone. No guarantee is provided for the actual timezone of the returned date, only the instant it represents is guaranteed

getOccurrences

List<CalendarEventOccurrence> getOccurrences(ZonedDateTime startDate,
 ZonedDateTime endDate)

Retrieves the list of all event date between startDate and endDate.

Parameters:

startDate - the start date

endDate - the end date

Returns:

the list of all event date between startDate and endDate.

getFirstOccurrence

Optional<CalendarEventOccurrence> getFirstOccurrence(ZonedDateTime date)

Retrieves the start date of the first Event which end after the date

Parameters:

date - the date

Returns:

the start date of the first Event which end after the date

getNextOccurrence

Optional<CalendarEventOccurrence> getNextOccurrence(CalendarEventOccurrence occurrence)

Retrieves the date of the next event after the date

Parameters:

occurrence - the current occurrence

Returns:

the occurrence of the next event after the date

getOrganiser

UserIdentity getOrganiser()

Retrieves the organiser.

Returns:

the organiser.

Throws:

AmetysRepositoryException - if an error occurs.

getResources

List<String> getResources()

Retrieves the resource list.

Returns:

the resource list.