Package org.ametys.plugins.workspaces.calendars.task

Class TaskCalendarEvent

java.lang.Object

org.ametys.plugins.workspaces.calendars.task.TaskCalendarEvent

All Implemented Interfaces:

AmetysObject, TagAwareAmetysObject, TaggableAmetysObject, CalendarEvent

public class TaskCalendarEvent
extends Object
implements CalendarEvent

Object for a task calendar event

Constructor Summary

Constructors

Constructor	Description
TaskCalendarEvent(Calendar calendar, Task task)	The constructor

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
String	getId()	Retrieves the unique identifier of this AmetysObject. It must be unique in the whole repository and must never be null. It must conform to the URI syntax: <protocol>://<protocol-specific-part>
UserIdentity	getLastContributor()	Retrieves the last contributor.
ZonedDateTime	getLastModified()	Retrieves the last modification date.
String	getLocation()	Get the location of the event
String	getName()	Retrieves the name of the current object.
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.
<A extends AmetysObject> A	getParent()	Returns the parent object in the Ametys hierarchy.
String	getParentPath()	Returns the path of the parent object in the Ametys hierarchy.
String	getPath()	Retrieves the path of the current object.
EventRecurrenceTypeEnum	getRecurrenceType()	Retrieves the recurrence type.
ZonedDateTime	getRepeatUntil()	Retrieves the end date of the frequency.
List<String>	getResources()	Retrieves the resource list.
ZonedDateTime	getStartDate()	Get the date of the begin of the event
Set<String>	getTags()	Retrieves current tags.
Task	getTask()	Return the task link to the calendar 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.
void	tag(String tag)	Tags.
void	untag(String tag)	Untags.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

equals, hashCode

Constructor Details

TaskCalendarEvent

public TaskCalendarEvent(Calendar calendar,
 Task task)

The constructor

Parameters:

calendar - the calendar

task - the task

Method Details

getTask

public Task getTask()

Return the task link to the calendar event

Returns:

the task

tag

public void tag(String tag)
         throws AmetysRepositoryException

Description copied from interface: TaggableAmetysObject

Tags.

Specified by:

tag in interface TaggableAmetysObject

Parameters:

tag - the tag to add.

Throws:

AmetysRepositoryException - if an error occurs.

untag

public void untag(String tag)
           throws AmetysRepositoryException

Description copied from interface: TaggableAmetysObject

Untags.

Specified by:

untag in interface TaggableAmetysObject

Parameters:

tag - the tag to remove.

Throws:

AmetysRepositoryException - if an error occurs.

getTags

public Set<String> getTags()
                    throws AmetysRepositoryException

Description copied from interface: TagAwareAmetysObject

Retrieves current tags.

Specified by:

getTags in interface TagAwareAmetysObject

Returns:

the current tags.

Throws:

AmetysRepositoryException - if an error occurs.

getName

public String getName()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the name of the current object.

Specified by:

getName in interface AmetysObject

Returns:

the name.

Throws:

AmetysRepositoryException - if an error occurs.

getPath

public String getPath()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the path of the current object.

Specified by:

getPath in interface AmetysObject

Returns:

the path.

Throws:

AmetysRepositoryException - if an error occurs.

getId

public String getId()
             throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the unique identifier of this AmetysObject.
It must be unique in the whole repository and must never be null.
It must conform to the URI syntax:
<protocol>://<protocol-specific-part>

Specified by:

getId in interface AmetysObject

Returns:

the unique identifier of this AmetysObject

Throws:

AmetysRepositoryException - if an error occurs.

getParent

public <A extends AmetysObject> A getParent()
                                     throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the parent object in the Ametys hierarchy.

Specified by:

getParent in interface AmetysObject

Type Parameters:

A - the type of the parent AmetysObject.

Returns:

the parent object or null if current object is the root.

Throws:

AmetysRepositoryException - if an error occurs.

getParentPath

public String getParentPath()
                     throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the path of the parent object in the Ametys hierarchy.

Specified by:

getParentPath in interface AmetysObject

Returns:

the path of the parent object.

Throws:

AmetysRepositoryException - if an error occurs.

getCalendar

public Calendar getCalendar()

Description copied from interface: CalendarEvent

Get the calendar holding the event

Specified by:

getCalendar in interface CalendarEvent

Returns:

the calendar

getTitle

public String getTitle()

Description copied from interface: CalendarEvent

Get the title of the event

Specified by:

getTitle in interface CalendarEvent

Returns:

the title of the event

getDescription

public String getDescription()

Description copied from interface: CalendarEvent

Get the description of the event

Specified by:

getDescription in interface CalendarEvent

Returns:

the description of the event

getLocation

public String getLocation()

Description copied from interface: CalendarEvent

Get the location of the event

Specified by:

getLocation in interface CalendarEvent

Returns:

the location of the event

getStartDate

public ZonedDateTime getStartDate()

Description copied from interface: CalendarEvent

Get the date of the begin of the event

Specified by:

getStartDate in interface CalendarEvent

Returns:

the date of the event

getEndDate

public ZonedDateTime getEndDate()

Description copied from interface: CalendarEvent

Get the date of the end of the event

Specified by:

getEndDate in interface CalendarEvent

Returns:

the date of the event

getZone

public ZoneId getZone()

Description copied from interface: CalendarEvent

Get the date zone of the event

Specified by:

getZone in interface CalendarEvent

Returns:

the date zone of the event

getFullDay

public Boolean getFullDay()

Description copied from interface: CalendarEvent

Get if the event last all the day

Specified by:

getFullDay in interface CalendarEvent

Returns:

true if the event last all the day

getCreator

public UserIdentity getCreator()

Description copied from interface: CalendarEvent

Retrieves the the creator.

Specified by:

getCreator in interface CalendarEvent

Returns:

the creator.

getCreationDate

public ZonedDateTime getCreationDate()

Description copied from interface: CalendarEvent

Retrieves the creation date.

Specified by:

getCreationDate in interface CalendarEvent

Returns:

the creation date.

getLastContributor

public UserIdentity getLastContributor()

Description copied from interface: CalendarEvent

Retrieves the last contributor.

Specified by:

getLastContributor in interface CalendarEvent

Returns:

the last contributor.

getLastModified

public ZonedDateTime getLastModified()

Description copied from interface: CalendarEvent

Retrieves the last modification date.

Specified by:

getLastModified in interface CalendarEvent

Returns:

the last modification date.

getRecurrenceType

public EventRecurrenceTypeEnum getRecurrenceType()

Description copied from interface: CalendarEvent

Retrieves the recurrence type.

Specified by:

getRecurrenceType in interface CalendarEvent

Returns:

the recurrence type.

isRecurrent

public Boolean isRecurrent()

Description copied from interface: CalendarEvent

Retrieves if the event is recurrent.

Specified by:

isRecurrent in interface CalendarEvent

Returns:

true if the event is recurrent.

getRepeatUntil

public ZonedDateTime getRepeatUntil()

Description copied from interface: CalendarEvent

Retrieves the end date of the frequency.

Specified by:

getRepeatUntil in interface CalendarEvent

Returns:

the end date of the frequency.

getExcludedOccurences

public List<ZonedDateTime> getExcludedOccurences()

Description copied from interface: CalendarEvent

Retrieves the list of excluded event date.

Specified by:

getExcludedOccurences in interface CalendarEvent

Returns:

the list of excluded event date.

getOccurrences

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

Description copied from interface: CalendarEvent

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

Specified by:

getOccurrences in interface CalendarEvent

Parameters:

startDate - the start date

endDate - the end date

Returns:

the list of all event date between startDate and endDate.

getFirstOccurrence

public Optional<CalendarEventOccurrence> getFirstOccurrence(ZonedDateTime date)

Description copied from interface: CalendarEvent

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

Specified by:

getFirstOccurrence in interface CalendarEvent

Parameters:

date - the date

Returns:

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

getNextOccurrence

public Optional<CalendarEventOccurrence> getNextOccurrence(CalendarEventOccurrence occurrence)

Description copied from interface: CalendarEvent

Retrieves the date of the next event after the date

Specified by:

getNextOccurrence in interface CalendarEvent

Parameters:

occurrence - the current occurrence

Returns:

the occurrence of the next event after the date

getOrganiser

public UserIdentity getOrganiser()

Description copied from interface: CalendarEvent

Retrieves the organiser.

Specified by:

getOrganiser in interface CalendarEvent

Returns:

the organiser.

getResources

public List<String> getResources()

Description copied from interface: CalendarEvent

Retrieves the resource list.

Specified by:

getResources in interface CalendarEvent

Returns:

the resource list.