Package org.ametys.plugins.explorer.calendars

Interface CalendarEvent

All Superinterfaces:

AmetysObject, JCRAmetysObject, MetadataAwareAmetysObject, ModifiableAmetysObject, ModifiableMetadataAwareAmetysObject, RemovableAmetysObject, WorkflowAwareAmetysObject

All Known Subinterfaces:

ModifiableCalendarEvent

All Known Implementing Classes:

JCRCalendarEvent

public interface CalendarEvent
extends WorkflowAwareAmetysObject

Calendar event interface

Method Summary

Modifier and Type	Method	Description
Date	getCreationDate()	Retrieves the creation date.
UserIdentity	getCreator()	Retrieves the the creator.
String	getDescription()	Get the description of the event
Date	getEndDate()	Get the date of the end of the event
List<Date>	getExcludedOccurences()	Retrieves the list of excluded event date.
Date	getFirstOccurrence(Date date)	Retrieves the start date of the first Event which end after the date
Boolean	getFullDay()	Get if the event last all the day
String[]	getKeywords()	Returns the keywords of this event, as a String array.
UserIdentity	getLastContributor()	Retrieves the last contributor.
Date	getLastModified()	Retrieves the last modification date.
Date	getLastValidated()	Retrieves the last validation date.
UserIdentity	getLastValidator()	Retrieves the last validator.
String	getLocation()	Get the location of the event
Date	getNextOccurrence(Date date)	Retrieves the date of the next event after the date
List<Date>	getOccurrences(Date startDate, Date endDate)	Retrieves the list of all event date between startDate and endDate.
UserIdentity	getOrganiser()	Retrieves the organiser.
EventRecurrenceTypeEnum	getRecurrenceType()	Retrieves the recurrence type.
Date	getRepeatUntil()	Retrieves the end date of the frequency.
Date	getStartDate()	Get the date of the begin of the event
String	getTitle()	Get the title 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.jcr.JCRAmetysObject

getNode

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

needsSave, rename, revertChanges, saveChanges

Methods inherited from interface org.ametys.plugins.repository.metadata.ModifiableMetadataAwareAmetysObject

getMetadataHolder

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

remove

Methods inherited from interface org.ametys.plugins.workflow.repository.WorkflowAwareAmetysObject

getCurrentStepId, getWorkflowId, setCurrentStepId, setWorkflowId

Method Details

getTitle

String getTitle()

Get the title of the event

Returns:

the title of the event

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

Date getStartDate()

Get the date of the begin of the event

Returns:

the date of the event

getEndDate

Date getEndDate()

Get the date of the end of the event

Returns:

the date 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()
                 throws UnknownMetadataException,
AmetysRepositoryException

Retrieves the the creator.

Returns:

the creator.

Throws:

UnknownMetadataException - if this property does not exists.

AmetysRepositoryException - if an error occurs.

getCreationDate

Date getCreationDate()
              throws UnknownMetadataException,
AmetysRepositoryException

Retrieves the creation date.

Returns:

the creation date.

Throws:

UnknownMetadataException - if this property does not exists.

AmetysRepositoryException - if an error occurs.

getLastContributor

UserIdentity getLastContributor()
                         throws UnknownMetadataException,
AmetysRepositoryException

Retrieves the last contributor.

Returns:

the last contributor.

Throws:

UnknownMetadataException - if this property does not exists.

AmetysRepositoryException - if an error occurs.

getLastModified

Date getLastModified()
              throws UnknownMetadataException,
AmetysRepositoryException

Retrieves the last modification date.

Returns:

the last modification date.

Throws:

UnknownMetadataException - if this property does not exists.

AmetysRepositoryException - if an error occurs.

getLastValidator

UserIdentity getLastValidator()
                       throws UnknownMetadataException,
AmetysRepositoryException

Retrieves the last validator.

Returns:

the last validator.

Throws:

UnknownMetadataException - if this property does not exists.

AmetysRepositoryException - if an error occurs.

getLastValidated

Date getLastValidated()
               throws UnknownMetadataException,
AmetysRepositoryException

Retrieves the last validation date.

Returns:

the last validation date.

Throws:

UnknownMetadataException - if this property does not exists.

AmetysRepositoryException - if an error occurs.

getKeywords

String[] getKeywords()
              throws AmetysRepositoryException

Returns the keywords of this event, as a String array.

Returns:

the keywords of this event.

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

Date getRepeatUntil()

Retrieves the end date of the frequency.

Returns:

the end date of the frequency.

getExcludedOccurences

List<Date> getExcludedOccurences()

Retrieves the list of excluded event date.

Returns:

the list of excluded event date.

getOccurrences

List<Date> getOccurrences(Date startDate,
 Date 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

Date getFirstOccurrence(Date 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

Date getNextOccurrence(Date date)

Retrieves the date of the next event after the date

Parameters:

date - the date

Returns:

the date of the next event after the date

getOrganiser

UserIdentity getOrganiser()
                   throws UnknownMetadataException,
AmetysRepositoryException

Retrieves the organiser.

Returns:

the organiser.

Throws:

UnknownMetadataException - if this property does not exists.

AmetysRepositoryException - if an error occurs.