Package org.alfresco.service.cmr.calendar

Interface CalendarEntry

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.alfresco.service.cmr.repository.NodeRef getContainerNodeRef()  
      java.util.Date getCreatedAt()  
      java.lang.String getDescription()  
      java.util.Date getEnd()  
      java.util.Date getLastRecurrence()
      Gets the date of the last instance of this recurring event, i.e.
      java.lang.String getLocation()  
      java.util.Date getModifiedAt()  
      org.alfresco.service.cmr.repository.NodeRef getNodeRef()
      Get the underlying node value that needs to be permission checked.
      java.lang.String getOutlookUID()
      Gets the UID used by Outlook for this event.
      java.lang.String getRecurrenceRule()
      Gets the event recurrence rule.
      java.lang.String getSharePointDocFolder()
      Gets the SharePoint "Doc Folder" for the event.
      java.util.Date getStart()  
      java.lang.String getSystemName()  
      java.util.List<java.lang.String> getTags()  
      java.lang.String getTitle()  
      boolean isOutlook()
      Is this an outlook based event?
      void setDescription​(java.lang.String description)
      Sets the Description of the event
      void setEnd​(java.util.Date end)
      Sets the event end date and time
      void setLastRecurrence​(java.util.Date lastRecurrence)
      Sets the date of the last instance of this recurring event
      void setLocation​(java.lang.String location)
      Sets the Location of the event
      void setOutlook​(boolean outlook)
      Sets if this is an outlook based event or not
      void setOutlookUID​(java.lang.String outlookUID)
      Sets the UID used by Outlook for this event.
      void setRecurrenceRule​(java.lang.String recurrenceRule)
      Sets the event recurrence rule, in SharePoint/Outlook format
      void setSharePointDocFolder​(java.lang.String docFolder)
      Sets the SharePoint "Doc Folder" for the event.
      void setStart​(java.util.Date start)
      Sets the event start date and time
      void setTitle​(java.lang.String title)
      Sets the Title ("what") of the event

    • Method Detail

      • getNodeRef

        org.alfresco.service.cmr.repository.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

        org.alfresco.service.cmr.repository.NodeRef getContainerNodeRef()
        Returns:
        the NodeRef of the site container this belongs to

      • getSystemName

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

      • getTitle

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

      • setTitle

        void setTitle​(java.lang.String title)
        Sets the Title ("what") of the event

      • getDescription

        java.lang.String getDescription()
        Returns:
        the Description of the event

      • setDescription

        void setDescription​(java.lang.String description)
        Sets the Description of the event

      • getLocation

        java.lang.String getLocation()
        Returns:
        the Location of the event

      • setLocation

        void setLocation​(java.lang.String location)
        Sets the Location of the event

      • getStart

        java.util.Date getStart()
        Returns:
        the Start date and time

      • setStart

        void setStart​(java.util.Date start)
        Sets the event start date and time

      • getEnd

        java.util.Date getEnd()
        Returns:
        the End date and time

      • setEnd

        void setEnd​(java.util.Date end)
        Sets the event end date and time

      • getRecurrenceRule

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

      • setRecurrenceRule

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

      • getLastRecurrence

        java.util.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​(java.util.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

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

      • setOutlookUID

        void setOutlookUID​(java.lang.String outlookUID)
        Sets the UID used by Outlook for this event. When a UID is set, normally the isOutlook flag is set too.

      • getSharePointDocFolder

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

      • setSharePointDocFolder

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

      • getTags

        java.util.List<java.lang.String> getTags()
        Returns:
        the Tags associated with the event

      • getCreatedAt

        java.util.Date getCreatedAt()
        Returns:
        the creation date and time

      • getModifiedAt

        java.util.Date getModifiedAt()
        Returns:
        the modification date and time