Package org.alfresco.service.cmr.calendar

Interface CalendarEntry

All Superinterfaces:
PermissionCheckValue, Serializable
All Known Implementing Classes:
CalendarEntryDTO, CalendarEntryImpl
public interface CalendarEntry extends Serializable, PermissionCheckValue
This class represents an event in a calendar.
Since:
4.0
Author:
Nick Burch

  • Method Details

    • getNodeRef

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

    • getContainerNodeRef

      NodeRef getContainerNodeRef()
      Returns:
      the NodeRef of the site container this belongs to

    • getSystemName

      String getSystemName()
      Returns:
      the System generated name for the event

    • getTitle

      String getTitle()
      Returns:
      the Title ("what") of the event

    • setTitle

      void setTitle(String title)
      Sets the Title ("what") of the event

    • getDescription

      String getDescription()
      Returns:
      the Description of the event

    • setDescription

      void setDescription(String description)
      Sets the Description of the event

    • getLocation

      String getLocation()
      Returns:
      the Location of the event

    • setLocation

      void setLocation(String location)
      Sets the Location of the event

    • getStart

      Date getStart()
      Returns:
      the Start date and time

    • setStart

      void setStart(Date start)
      Sets the event start date and time

    • getEnd

      Date getEnd()
      Returns:
      the End date and time

    • setEnd

      void setEnd(Date end)
      Sets the event end date and time

    • getRecurrenceRule

      String getRecurrenceRule()
      Gets the event recurrence rule. This needs to be in the SharePoint/Outlook format of FREQ=...;INTERVAL=...;BY...=...;COUNT=...

    • setRecurrenceRule

      void setRecurrenceRule(String recurrenceRule)
      Sets the event recurrence rule, in SharePoint/Outlook format

    • getLastRecurrence

      Date getLastRecurrence()
      Gets the date of the last instance of this recurring event, i.e. the last date up until which recurrances will occur.

    • setLastRecurrence

      void setLastRecurrence(Date lastRecurrence)
      Sets the date of the last instance of this recurring event

    • isOutlook

      boolean isOutlook()
      Is this an outlook based event?

    • setOutlook

      void setOutlook(boolean outlook)
      Sets if this is an outlook based event or not

    • getOutlookUID

      String getOutlookUID()
      Gets the UID used by Outlook for this event. See isOutlook()

    • setOutlookUID

      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.

    • getSharePointDocFolder

      String getSharePointDocFolder()
      Gets the SharePoint "Doc Folder" for the event. Only used for SharePoint based events

    • setSharePointDocFolder

      void setSharePointDocFolder(String docFolder)
      Sets the SharePoint "Doc Folder" for the event. Only used for SharePoint based events

    • getTags

      List<String> getTags()
      Returns:
      the Tags associated with the event

    • getCreatedAt

      Date getCreatedAt()
      Returns:
      the creation date and time

    • getModifiedAt

      Date getModifiedAt()
      Returns:
      the modification date and time