Package org.alfresco.service.cmr.calendar

Class CalendarEntryDTO

java.lang.Object
org.alfresco.service.cmr.calendar.CalendarEntryDTO
All Implemented Interfaces:
Serializable, PermissionCheckValue, CalendarEntry
Direct Known Subclasses:
CalendarEntryImpl
public class CalendarEntryDTO extends Object implements CalendarEntry, Serializable
This class represents an event in a calendar.
Since:
4.0
Author:
Nick Burch
See Also:

  • Constructor Details

    • CalendarEntryDTO

      public CalendarEntryDTO()
      Creates an empty CalendarEntry, which can be populated with set calls.

    • CalendarEntryDTO

      public CalendarEntryDTO(String title, String description, String location, Date start, Date end)
      Creates a CalendarEntry with common properties.

  • Method Details

    • getNodeRef

      public NodeRef getNodeRef()
      Description copied from interface: PermissionCheckValue
      Get the underlying node value that needs to be permission checked.
      Specified by:
      getNodeRef in interface CalendarEntry
      Specified by:
      getNodeRef in interface PermissionCheckValue
      Returns:
      the NodeRef of the underlying calendar entry

    • getContainerNodeRef

      public NodeRef getContainerNodeRef()
      Specified by:
      getContainerNodeRef in interface CalendarEntry
      Returns:
      the NodeRef of the calendar's container in the site

    • getSystemName

      public String getSystemName()
      Specified by:
      getSystemName in interface CalendarEntry
      Returns:
      the System generated name for the event

    • getTitle

      public String getTitle()
      Specified by:
      getTitle in interface CalendarEntry
      Returns:
      the Title ("what") of the event

    • setTitle

      public void setTitle(String title)
      Sets the Title ("what") of the event
      Specified by:
      setTitle in interface CalendarEntry

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface CalendarEntry
      Returns:
      the Description of the event

    • setDescription

      public void setDescription(String description)
      Sets the Description of the event
      Specified by:
      setDescription in interface CalendarEntry

    • getLocation

      public String getLocation()
      Specified by:
      getLocation in interface CalendarEntry
      Returns:
      the Location of the event

    • setLocation

      public void setLocation(String location)
      Sets the Location of the event
      Specified by:
      setLocation in interface CalendarEntry

    • getStart

      public Date getStart()
      Specified by:
      getStart in interface CalendarEntry
      Returns:
      the Start date and time

    • setStart

      public void setStart(Date start)
      Sets the event start date and time
      Specified by:
      setStart in interface CalendarEntry

    • getEnd

      public Date getEnd()
      Specified by:
      getEnd in interface CalendarEntry
      Returns:
      the End date and time

    • setEnd

      public void setEnd(Date end)
      Sets the event end date and time
      Specified by:
      setEnd in interface CalendarEntry

    • getRecurrenceRule

      public String getRecurrenceRule()
      Gets the event recurrence rule.
      Specified by:
      getRecurrenceRule in interface CalendarEntry

    • setRecurrenceRule

      public void setRecurrenceRule(String recurrenceRule)
      Sets the event recurrence rule
      Specified by:
      setRecurrenceRule in interface CalendarEntry

    • getLastRecurrence

      public Date getLastRecurrence()
      Gets the date of the last instance of this recurring event
      Specified by:
      getLastRecurrence in interface CalendarEntry

    • setLastRecurrence

      public void setLastRecurrence(Date lastRecurrence)
      Sets the date of the last instance of this recurring event
      Specified by:
      setLastRecurrence in interface CalendarEntry

    • isOutlook

      public boolean isOutlook()
      Is this an outlook based event?
      Specified by:
      isOutlook in interface CalendarEntry

    • setOutlook

      public void setOutlook(boolean outlook)
      Sets if this is an outlook based event or not
      Specified by:
      setOutlook in interface CalendarEntry

    • getOutlookUID

      public String getOutlookUID()
      Gets the UID used by Outlook for this event. See CalendarEntry.isOutlook()
      Specified by:
      getOutlookUID in interface CalendarEntry

    • setOutlookUID

      public void setOutlookUID(String outlookUID)
      Sets the UID used by Outlook for this event. When a UID is set, normally the isOutlook flag is set too.
      Specified by:
      setOutlookUID in interface CalendarEntry

    • getSharePointDocFolder

      public String getSharePointDocFolder()
      Gets the SharePoint "Doc Folder" for the event. Only used for SharePoint based events
      Specified by:
      getSharePointDocFolder in interface CalendarEntry

    • setSharePointDocFolder

      public void setSharePointDocFolder(String docFolder)
      Sets the SharePoint "Doc Folder" for the event. Only used for SharePoint based events
      Specified by:
      setSharePointDocFolder in interface CalendarEntry

    • getTags

      public List<String> getTags()
      Specified by:
      getTags in interface CalendarEntry
      Returns:
      the Tags associated with the event

    • getCreatedAt

      public Date getCreatedAt()
      Gets when this entry was created
      Specified by:
      getCreatedAt in interface CalendarEntry
      Returns:
      the creation date and time

    • setCreatedAt

      public void setCreatedAt(Date createdAt)

    • getModifiedAt

      public Date getModifiedAt()
      Gets when this entry was modified
      Specified by:
      getModifiedAt in interface CalendarEntry
      Returns:
      the modification date and time

    • setModifiedAt

      public void setModifiedAt(Date modifiedAt)

    • isAllDay

      public static boolean isAllDay(CalendarEntry entry)
      Does the given CalendarEntry define an all-day event? An All Day Event is defined as one starting at midnight on a day, and ending at midnight. For a single day event, the start and end dates should be the same, and the times for both are UTC midnight. For a multi day event, the start and end times are UTC midnight, for the first and last days respectively.