Package com.jalios.jcms.calendar

Interface CalendarEventInterface

  • All Known Implementing Classes:
    AbstractCalendarEvent
    @Deprecated
public interface CalendarEventInterface
    Deprecated.
    this class will be moved to CalendarPlugin and will be removed in further version

    • Method Detail

      • getStartDate

        java.util.Date getStartDate()
        Deprecated.

      • getEndDate

        java.util.Date getEndDate()
        Deprecated.

      • getImportanceLevel

        java.lang.String getImportanceLevel()
        Deprecated.

      • getAuthorAttendee

        boolean getAuthorAttendee()
        Deprecated.

      • setAuthorAttendee

        void setAuthorAttendee​(boolean b)
        Deprecated.

      • getDayEventFlag

        boolean getDayEventFlag()
        Deprecated.

      • setStartDate

        void setStartDate​(java.util.Date date)
        Deprecated.

      • setEndDate

        void setEndDate​(java.util.Date date)
        Deprecated.

      • getReminderDuration

        long getReminderDuration()
        Deprecated.

      • setReminderDuration

        void setReminderDuration​(long v)
        Deprecated.

      • getAttendingMembers

        Member[] getAttendingMembers()
        Deprecated.

      • setAttendingMembers

        void setAttendingMembers​(Member[] v)
        Deprecated.

      • getAttendingGroups

        Group[] getAttendingGroups()
        Deprecated.

      • setAttendingGroups

        void setAttendingGroups​(Group[] v)
        Deprecated.

      • getLocation

        java.lang.String getLocation()
        Deprecated.

      • setLocation

        void setLocation​(java.lang.String v)
        Deprecated.

      • getPeriodicity

        java.lang.String getPeriodicity()
        Deprecated.

      • setPeriodicity

        void setPeriodicity​(java.lang.String v)
        Deprecated.

      • getPeriodicityEndDate

        java.util.Date getPeriodicityEndDate()
        Deprecated.

      • setPeriodicityEndDate

        void setPeriodicityEndDate​(java.util.Date v)
        Deprecated.

      • getPrivateFlag

        boolean getPrivateFlag()
        Deprecated.

      • setPrivateFlag

        void setPrivateFlag​(boolean v)
        Deprecated.

      • setDocuments

        void setDocuments​(FileDocument[] v)
        Deprecated.

      • getSendEventUpdateMail

        boolean getSendEventUpdateMail()
        Deprecated.

      • setSendEventUpdateMail

        void setSendEventUpdateMail​(boolean v)
        Deprecated.

      • getFreeSignUp

        boolean getFreeSignUp()
        Deprecated.

      • setFreeSignUp

        void setFreeSignUp​(boolean v)
        Deprecated.

      • getLocation

        java.lang.String getLocation​(java.lang.String lang)
        Deprecated.

      • getDescription

        java.lang.String getDescription​(java.lang.String lang)
        Deprecated.

      • getEventDuration

        long getEventDuration()
        Deprecated.
        Returns the event duration
        Returns:
        the event duration or -1 if start date or end date is null

      • overlapWith

        boolean overlapWith​(CalendarEventInterface ev)
        Deprecated.
        Check if calendar event overlap with another one
        Parameters:
        ev - the other calendar event
        Returns:
        true if they overlap, false otherwise
        Since:
        jcms-4.1.1

      • overlapWith

        boolean overlapWith​(java.util.Date startDate,
                    java.util.Date endDate)
        Deprecated.
        Check if calendar event overlap with given interval
        Parameters:
        startDate - the start date of the interval to check
        endDate - the end date of the interval to check
        Returns:
        true if event overlap with given interval, false otherwise
        Since:
        jcms-4.1.1

      • isAttendee

        boolean isAttendee​(Member mbr)
        Deprecated.
        Check if a given member attends this calendar event (Warning: read right are not checked), either because he is in a group attending the event or else if he is in the list of attendees
        Parameters:
        mbr - the member to check
        Returns:
        true if the member attends the event, false otherwise

      • isAttendee

        boolean isAttendee​(Member mbr,
                   boolean checkReadRight)
        Deprecated.
        Check if a given member attends this calendar event, either because he is in a group attending the event or else if he is in the list of attendees
        Parameters:
        mbr - the member to check
        checkReadRight - set to true if read right should be checked (in which case a member is considered attendee only when is can read the event), set to false if read right should not be checked (in which case a member is considered attendee event if he cannot read the event)
        Returns:
        true if the member attends the event, false otherwise
        Since:
        jcms-6.1.3

      • isReminderEnabled

        boolean isReminderEnabled()
        Deprecated.
        Returns:
        true if reminder is enabled, false otherwise
        Since:
        jcms-4.1.1

      • getReminderDate

        java.util.Date getReminderDate()
        Deprecated.
        Returns:
        the reminder date
        Since:
        jcms-4.1.1

      • getAllAttendingMembersSet

        java.util.TreeSet<Member> getAllAttendingMembersSet()
        Deprecated.
        Return a set containing all the members attending this event. Contains all members from the attendees groups and the attendees member, who can read this calendar event (this set is built and cached on create/update of event).
        Returns:
        a TreeSet of all member attending to this event
        Since:
        jcms-5.0.0

      • getAllAttendingMembersSet

        java.util.TreeSet<Member> getAllAttendingMembersSet​(boolean checkReadRight)
        Deprecated.
        Return a set containing all the members attending this event checking for readright or not. Contains all members from the attendees groups and the attendees member, (this set is built and cached on create/update of event).
        Parameters:
        checkReadRight - set to true if read right should be checked, false if all attendee should be included even Member not able to read the event
        Returns:
        a TreeSet of all member attending to this event
        Since:
        jcms-6.1.3

      • getAttendingMemberSet

        java.util.TreeSet<Member> getAttendingMemberSet()
        Deprecated.
        Retrieve the attending members as a Set, with the author included.
        Returns:
        the set of attending members corresponding to attenginmembers with author added, never return null
        Since:
        jcms-6.1.1

      • removeAttendee

        boolean removeAttendee​(Member mbr)
        Deprecated.
        Remove given member from the attending members, updates the all member set. Note: Does not perform update in store, this method must be called on the clone to be updated.
        Parameters:
        mbr - the Member to remove
        Returns:
        true if a modification was made
        Since:
        jcms-5.0.0

      • updateAllAttendingMembersSet

        void updateAllAttendingMembersSet()
        Deprecated.
        Clear and update the transient cache of all attending member set.
        Since:
        jcms-5.0.1

      • remind

        void remind()
        Deprecated.
        remind author and attendees of event
        Since:
        jcms-4.1.1

      • getDataIconHtml

        java.lang.String getDataIconHtml()
        Deprecated.
        Compute html icon for this event
        Returns:
        the html string of the icon

      • getDataIconHtml

        java.lang.String getDataIconHtml​(java.lang.String lang,
                                 CalendarEventInterface.IconSize size)
        Deprecated.
        Compute html icon for this event by specifying a size in parameter.
        Parameters:
        lang - the user language.
        size - icon size
        Returns:
        the html string of the icon
        Since:
        jcms-8

      • getUseFrontOfficeCalendarEditionModal

        boolean getUseFrontOfficeCalendarEditionModal()
        Deprecated.
        Whether we use the Calendar edition modal in Front Office.
        Returns:
        true if we use the Calendar edition modal.
        Since:
        jcms-8