Package org.sakaiproject.signup.restful

Class SignupEvent

  • All Implemented Interfaces:
    org.sakaiproject.entity.api.Entity, MeetingTypes
    public class SignupEvent
extends Object
implements org.sakaiproject.entity.api.Entity, MeetingTypes

    This class holds the information of sign-up meeting/event for RESTful and it's a wrapper class for SignupMeeting.

    Author:
    Peter Liu

    • Constructor Detail

      • SignupEvent

        public SignupEvent()

    • Method Detail

      • getId

        public String getId()
        Specified by:
        getId in interface org.sakaiproject.entity.api.Entity

      • setId

        public void setId​(String s)

      • getEventId

        public Long getEventId()
        get the unique meeting/event Id, which is generated by DB
        Returns:
        an unique sequence Id

      • setEventId

        public void setEventId​(Long id)
        this is a setter.
        Parameters:
        id - an unique sequence Id

      • getTitle

        public String getTitle()
        get the name of the event/meeting
        Returns:
        the name of the event/meeting

      • setTitle

        public void setTitle​(String title)
        this is a setter
        Parameters:
        title - a name of the event/meeting

      • getOrganizerName

        public String getOrganizerName()

      • setOrganizerName

        public void setOrganizerName​(String organizerName)

      • getLocation

        public String getLocation()
        get the location, where the event/meeting occurs
        Returns:
        the location

      • setLocation

        public void setLocation​(String location)
        this is a setter.
        Parameters:
        location - a location, where the event/meeting occurs

      • getDescription

        public String getDescription()
        get the description of the event/meeting
        Returns:
        a description

      • setDescription

        public void setDescription​(String description)
        this is a setter.
        Parameters:
        description - a description of an event/meeting

      • getEndTime

        public Date getEndTime()
        get the end time of an event/meeting
        Returns:
        an end time of the event/meeting

      • setEndTime

        public void setEndTime​(Date endTime)
        this is a setter.
        Parameters:
        endTime - the end time of the event/meeting

      • getAvailableStatus

        public String getAvailableStatus()

      • setAvailableStatus

        public void setAvailableStatus​(String availableStatus)

      • getMeetingType

        public String getMeetingType()
        get the event/meeting type (individual,group and announcement)
        Returns:
        one of the type (individual,group and announcement)

      • setMeetingType

        public void setMeetingType​(String meetingType)
        this is a setter
        Parameters:
        meetingType - a defined meeting type (individual,group and announcement)

      • getNoOfTimeSlots

        public int getNoOfTimeSlots()
        This method obtains the number of time slots in the event/meeting
        Returns:
        the number of time slots

      • getRecurrenceId

        public Long getRecurrenceId()
        get the recurrence Id of the event/meeting
        Returns:
        the recurrence Id

      • setRecurrenceId

        public void setRecurrenceId​(Long recurrenceId)
        this is a setter.
        Parameters:
        recurrenceId - a unique Id

      • getStartTime

        public Date getStartTime()
        get the starting time of the event/meeting
        Returns:
        the starting date of the event/meeting

      • setStartTime

        public void setStartTime​(Date startTime)
        this is a setter
        Parameters:
        startTime - the time when the event/meeting starts

      • getDate

        public Date getDate()
        This is a extra field for JSON object to display the event date. It's the same as startTime and it will make nested JSON object processing much easier.
        Returns:
        a Date object

      • getSignupBegins

        public Date getSignupBegins()
        get the signup starting time for the event/meeting
        Returns:
        a starting time for signup

      • setSignupBegins

        public void setSignupBegins​(Date signupBegins)
        this is a setter
        Parameters:
        signupBegins - a time when the signup process starts

      • getSignupDeadline

        public Date getSignupDeadline()
        get the time when the signup process stops
        Returns:
        a date of the signup deadline

      • setSignupDeadline

        public void setSignupDeadline​(Date signupDeadLine)
        this is a setter
        Parameters:
        signupDeadLine - the time when signup process stops

      • isAllowWaitList

        public boolean isAllowWaitList()

      • setAllowWaitList

        public void setAllowWaitList​(boolean allowWaitList)

      • isAllowComment

        public boolean isAllowComment()

      • setAllowComment

        public void setAllowComment​(boolean allowComment)

      • getRepeatType

        public String getRepeatType()

      • setRepeatType

        public void setRepeatType​(String repeatType)

      • isMySignupEvents

        public boolean isMySignupEvents()

      • getMyStartTime

        public Date getMyStartTime()

      • setMyStartTime

        public void setMyStartTime​(Date myStartTime)

      • getMyEndTime

        public Date getMyEndTime()

      • setMyEndTime

        public void setMyEndTime​(Date myEndTime)

      • isallowAttendance

        public boolean isallowAttendance()
        check if the meeting/event can take attendance
        Returns:
        true if the meeting/event can take attendance

      • setAllowAttendance

        public void setAllowAttendance​(boolean allowAttendance)
        this is a setter.
        Parameters:
        allowAttendance - a boolean value

      • getMaxNumberOfAttendees

        public int getMaxNumberOfAttendees()
        get the maximum nubmer of the attendees, which is allowed in one time slot
        Returns:
        the maximum nubmer of the attendees

      • getSignupSiteItems

        public List<SignupSiteItem> getSignupSiteItems()
        get a list of SignupSiteItem objects, which indicate the scope of the event/meeting
        Returns:
        a list of SignupSiteItem objects,

      • setSignupSiteItems

        public void setSignupSiteItems​(List<SignupSiteItem> signupSites)
        this is a setter
        Parameters:
        SignupSiteItem - a SignupSiteItem object

      • isStartToSignUp

        public boolean isStartToSignUp()
        This will test if the event/meeting is started to sign up
        Returns:
        true if the sign-up begin time is before current time.

      • isMeetingExpired

        public boolean isMeetingExpired()
        This method will check if the event/meeting is already expired
        Returns:
        true if the event/meeting is expired

      • isPassedDeadline

        public boolean isPassedDeadline()
        This method will check if the current time has already passed the signup deadline
        Returns:
        true if the current time has already passed the signup deadline

      • isMeetingCrossDays

        public boolean isMeetingCrossDays()
        This will test if the event/meeting is cross days
        Returns:
        true if the event/meeting is cross days

      • isCurrentUserSignedUp

        public boolean isCurrentUserSignedUp()

      • setCurrentUserSignedUp

        public void setCurrentUserSignedUp​(boolean currentUserSignedUp)

      • getAllowedUserActionTypes

        public String[] getAllowedUserActionTypes()

      • setAllowedUserActionTypes

        public void setAllowedUserActionTypes​(String[] types)

      • getSignupTimeSlotItems

        public List<SignupTimeslotItem> getSignupTimeSlotItems()
        get a list of SignupTimeslot objects, which contains the event/meeting segments information
        Returns:
        a list of SignupTimeslot objects

      • setSignupTimeSlotItems

        public void setSignupTimeSlotItems​(List<SignupTimeslotItem> signupTimeSlotItems)
        this is a setter.
        Parameters:
        signupTimeSlots - a list of SignupTimeslot objects

      • getSignupMainEventAttachItems

        public List<SignupAttachment> getSignupMainEventAttachItems()
        This method provides the attachments for main Sign-up event page and is public to whole site.
        Returns:
        a list of SignupAttachment objects.

      • setSignupMainEventAttachItems

        public void setSignupMainEventAttachItems​(List<SignupAttachment> signupMainEventAttachItems)
        this is a setter. it only holds the attachments, which belongs to the entire event, not to individual time slot or participant
        Parameters:
        SignupAttachment - a list of SignupAttachment objects

      • getPermission

        public Permission getPermission()
        get the Permission object, which contains the user's operation permissions on this event/meeting
        Returns:
        a Permission object

      • setPermission

        public void setPermission​(Permission permission)
        this is a setter
        Parameters:
        permission - a permission object

      • getAllocToTSid

        public String getAllocToTSid()

      • setAllocToTSid

        public void setAllocToTSid​(String allocToTSid)

      • getUserActionType

        public String getUserActionType()

      • setUserActionType

        public void setUserActionType​(String userActionType)

      • getSiteId

        public String getSiteId()

      • setSiteId

        public void setSiteId​(String siteId)

      • isEidInputMode

        public boolean isEidInputMode()

      • setEidInputMode

        public void setEidInputMode​(boolean eidInputMode)

      • isAutoReminder

        public boolean isAutoReminder()

      • setAutoReminder

        public void setAutoReminder​(boolean autoReminder)

      • getProperties

        public org.sakaiproject.entity.api.ResourceProperties getProperties()
        Specified by:
        getProperties in interface org.sakaiproject.entity.api.Entity

      • getReference

        public String getReference()
        Specified by:
        getReference in interface org.sakaiproject.entity.api.Entity

      • getReference

        public String getReference​(String arg0)
        Specified by:
        getReference in interface org.sakaiproject.entity.api.Entity

      • getServerUrl

        public String getServerUrl()

      • getUrl

        public String getUrl()
        Specified by:
        getUrl in interface org.sakaiproject.entity.api.Entity

      • getUrl

        public String getUrl​(String arg0)
        Specified by:
        getUrl in interface org.sakaiproject.entity.api.Entity

      • toXml

        public Element toXml​(Document doc,
                     Stack stack)
        Specified by:
        toXml in interface org.sakaiproject.entity.api.Entity

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • getUserActionWarningMsg

        public String getUserActionWarningMsg()

      • setUserActionWarningMsg

        public void setUserActionWarningMsg​(String userActionWarningMsg)

      • getMaxNumOfSlots

        public Integer getMaxNumOfSlots()

      • setMaxNumOfSlots

        public void setMaxNumOfSlots​(Integer maxNumOfSlots)