SignupEvent (Sakai Signup API 10.2 API)

java.lang.Object
- org.sakaiproject.signup.restful.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

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALLOCATE_TO_TS_ID_FIELD_NAME`
`static String`	`SITE_ID_FIELD_NAME`
`static String`	`USER_ACTION_TYPE_FIELD_NAME`
`static String`	`USER_ADD_TO_WAITLIST`
`static String[]`	`USER_ATION_Types`
`static String`	`USER_CANCEL_SIGNUP`
`static String`	`USER_REMOVE_FROM_WAITLIST`
`static String`	`USER_SIGNUP`

Fields inherited from interface org.sakaiproject.entity.api.Entity
SEPARATOR

Fields inherited from interface org.sakaiproject.signup.model.MeetingTypes
ANNOUNCEMENT, BIWEEKLY, CUSTOM_TIMESLOTS, DAILY, GROUP, INDIVIDUAL, ONCE_ONLY, WEEKDAYS, WEEKLY

Constructor Summary

Constructors
Constructor and Description

SignupEvent()

Constructors
Constructor and Description
`SignupEvent()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getAllocToTSid()`
`String[]`	`getAllowedUserActionTypes()`
`String`	`getAvailableStatus()`
`Date`	`getDate()` This is a extra field for JSON object to display the event date.
`String`	`getDescription()` get the description of the event/meeting
`Date`	`getEndTime()` get the end time of an event/meeting
`Long`	`getEventId()` get the unique meeting/event Id, which is generated by DB
`String`	`getId()`
`String`	`getLocation()` get the location, where the event/meeting occurs
`int`	`getMaxNumberOfAttendees()` get the maximum nubmer of the attendees, which is allowed in one time slot
`Integer`	`getMaxNumOfSlots()`
`String`	`getMeetingType()` get the event/meeting type (individual,group and announcement)
`Date`	`getMyEndTime()`
`Date`	`getMyStartTime()`
`int`	`getNoOfTimeSlots()` This method obtains the number of time slots in the event/meeting
`String`	`getOrganizerName()`
`Permission`	`getPermission()` get the Permission object, which contains the user's operation permissions on this event/meeting
`org.sakaiproject.entity.api.ResourceProperties`	`getProperties()`
`Long`	`getRecurrenceId()` get the recurrence Id of the event/meeting
`String`	`getReference()`
`String`	`getReference(String arg0)`
`String`	`getRepeatType()`
`String`	`getServerUrl()`
`Date`	`getSignupBegins()` get the signup starting time for the event/meeting
`Date`	`getSignupDeadline()` get the time when the signup process stops
`List<SignupAttachment>`	`getSignupMainEventAttachItems()` This method provides the attachments for main Sign-up event page and is public to whole site.
`List<SignupSiteItem>`	`getSignupSiteItems()` get a list of SignupSiteItem objects, which indicate the scope of the event/meeting
`List<SignupTimeslotItem>`	`getSignupTimeSlotItems()` get a list of SignupTimeslot objects, which contains the event/meeting segments information
`String`	`getSiteId()`
`Date`	`getStartTime()` get the starting time of the event/meeting
`String`	`getTitle()` get the name of the event/meeting
`String`	`getUrl()`
`String`	`getUrl(String arg0)`
`String`	`getUserActionType()`
`String`	`getUserActionWarningMsg()`
`int`	`hashCode()`
`boolean`	`isallowAttendance()` check if the meeting/event can take attendance
`boolean`	`isAllowComment()`
`boolean`	`isAllowWaitList()`
`boolean`	`isAutoReminder()`
`boolean`	`isCurrentUserSignedUp()`
`boolean`	`isEidInputMode()`
`boolean`	`isMeetingCrossDays()` This will test if the event/meeting is cross days
`boolean`	`isMeetingExpired()` This method will check if the event/meeting is already expired
`boolean`	`isMySignupEvents()`
`boolean`	`isPassedDeadline()` This method will check if the current time has already passed the signup deadline
`boolean`	`isStartToSignUp()` This will test if the event/meeting is started to sign up
`void`	`setAllocToTSid(String allocToTSid)`
`void`	`setAllowAttendance(boolean allowAttendance)` this is a setter.
`void`	`setAllowComment(boolean allowComment)`
`void`	`setAllowedUserActionTypes(String[] types)`
`void`	`setAllowWaitList(boolean allowWaitList)`
`void`	`setAutoReminder(boolean autoReminder)`
`void`	`setAvailableStatus(String availableStatus)`
`void`	`setCurrentUserSignedUp(boolean currentUserSignedUp)`
`void`	`setDescription(String description)` this is a setter.
`void`	`setEidInputMode(boolean eidInputMode)`
`void`	`setEndTime(Date endTime)` this is a setter.
`void`	`setEventId(Long id)` this is a setter.
`void`	`setId(String s)`
`void`	`setLocation(String location)` this is a setter.
`void`	`setMaxNumOfSlots(Integer maxNumOfSlots)`
`void`	`setMeetingType(String meetingType)` this is a setter
`void`	`setMyEndTime(Date myEndTime)`
`void`	`setMyStartTime(Date myStartTime)`
`void`	`setOrganizerName(String organizerName)`
`void`	`setPermission(Permission permission)` this is a setter
`void`	`setRecurrenceId(Long recurrenceId)` this is a setter.
`void`	`setRepeatType(String repeatType)`
`void`	`setSignupBegins(Date signupBegins)` this is a setter
`void`	`setSignupDeadline(Date signupDeadLine)` this is a setter
`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
`void`	`setSignupSiteItems(List<SignupSiteItem> signupSites)` this is a setter
`void`	`setSignupTimeSlotItems(List<SignupTimeslotItem> signupTimeSlotItems)` this is a setter.
`void`	`setSiteId(String siteId)`
`void`	`setStartTime(Date startTime)` this is a setter
`void`	`setTitle(String title)` this is a setter
`void`	`setUserActionType(String userActionType)`
`void`	`setUserActionWarningMsg(String userActionWarningMsg)`
`String`	`toString()`
`Element`	`toXml(Document doc, Stack stack)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - USER_SIGNUP
```
public static final String USER_SIGNUP
```
    See Also:
    Constant Field Values
  - USER_CANCEL_SIGNUP
```
public static final String USER_CANCEL_SIGNUP
```
    See Also:
    Constant Field Values
  - USER_ADD_TO_WAITLIST
```
public static final String USER_ADD_TO_WAITLIST
```
    See Also:
    Constant Field Values
  - USER_REMOVE_FROM_WAITLIST
```
public static final String USER_REMOVE_FROM_WAITLIST
```
    See Also:
    Constant Field Values
  - USER_ACTION_TYPE_FIELD_NAME
```
public static final String USER_ACTION_TYPE_FIELD_NAME
```
    See Also:
    Constant Field Values
  - ALLOCATE_TO_TS_ID_FIELD_NAME
```
public static final String ALLOCATE_TO_TS_ID_FIELD_NAME
```
    See Also:
    Constant Field Values
  - SITE_ID_FIELD_NAME
```
public static final String SITE_ID_FIELD_NAME
```
    See Also:
    Constant Field Values
  - USER_ATION_Types
```
public static final String[] USER_ATION_Types
```
- 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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getUserActionWarningMsg
```
public String getUserActionWarningMsg()
```
  - setUserActionWarningMsg
```
public void setUserActionWarningMsg(String userActionWarningMsg)
```
  - getMaxNumOfSlots
```
public Integer getMaxNumOfSlots()
```
  - setMaxNumOfSlots
```
public void setMaxNumOfSlots(Integer maxNumOfSlots)
```

Class SignupEvent

Field Summary

Fields inherited from interface org.sakaiproject.entity.api.Entity

Fields inherited from interface org.sakaiproject.signup.model.MeetingTypes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USER_SIGNUP

USER_CANCEL_SIGNUP

USER_ADD_TO_WAITLIST

USER_REMOVE_FROM_WAITLIST

USER_ACTION_TYPE_FIELD_NAME

ALLOCATE_TO_TS_ID_FIELD_NAME

SITE_ID_FIELD_NAME

USER_ATION_Types

Constructor Detail

SignupEvent

Method Detail

getId

setId

getEventId

setEventId

getTitle

setTitle

getOrganizerName

setOrganizerName

getLocation

setLocation

getDescription

setDescription

getEndTime

setEndTime

getAvailableStatus

setAvailableStatus

getMeetingType

setMeetingType

getNoOfTimeSlots

getRecurrenceId

setRecurrenceId

getStartTime

setStartTime

getDate

getSignupBegins

setSignupBegins

getSignupDeadline

setSignupDeadline

isAllowWaitList

setAllowWaitList

isAllowComment

setAllowComment

getRepeatType

setRepeatType

isMySignupEvents

getMyStartTime

setMyStartTime

getMyEndTime

setMyEndTime

isallowAttendance

setAllowAttendance

getMaxNumberOfAttendees

getSignupSiteItems

setSignupSiteItems

isStartToSignUp

isMeetingExpired

isPassedDeadline

isMeetingCrossDays

isCurrentUserSignedUp

setCurrentUserSignedUp

getAllowedUserActionTypes

setAllowedUserActionTypes

getSignupTimeSlotItems

setSignupTimeSlotItems

getSignupMainEventAttachItems

setSignupMainEventAttachItems

getPermission

setPermission

getAllocToTSid

setAllocToTSid

getUserActionType