SignupMeetingsBean (Sakai Signup Tool 10.4 API)

java.lang.Object
- org.sakaiproject.signup.tool.jsf.SignupMeetingsBean

All Implemented Interfaces:

SignupBeanConstants

Direct Known Subclasses:

DownloadEventBean
```
public class SignupMeetingsBean
extends Object
implements SignupBeanConstants
```
This JSF UIBean class will handle information exchanges between main events/meetings list view page:orgSignupMeetings.jsp and backbone system. It provides all the necessary business logic

Field Summary

Fields
Modifier and Type	Field and Description
`protected AttendanceSignupBean`	`attendanceSignupBean`
`protected AttendeeSignupMBean`	`attendeeSignupMBean`
`protected Boolean`	`categoriesExist`
`protected String`	`categoryFilter`
`protected String`	`disabledSelectView`
`protected boolean`	`enableExpandOption`
`protected Boolean`	`locationsExist`
`protected UIData`	`meetingTable`
`protected String`	`meetingUnavailableMessages`
`protected OrganizerSignupMBean`	`organizerSignupMBean`
`protected org.sakaiproject.signup.logic.SakaiFacade`	`sakaiFacade`
`protected boolean`	`showAllRecurMeetings`
`protected List<SignupMeetingWrapper>`	`signupMeetings`
`protected org.sakaiproject.signup.logic.SignupMeetingService`	`signupMeetingService`
`protected SignupSorter`	`signupSorter`
`protected String`	`viewDateRang`
`protected List<SelectItem>`	`viewDropDownList`

Fields inherited from interface org.sakaiproject.signup.tool.util.SignupBeanConstants
ADD_MEETING_PAGE_URL, ADD_MEETING_STEP1_PAGE_URL, ADD_MEETING_STEP2_PAGE_URL, ALL_FUTURE, ATTACH_COPY, ATTACH_MODIFY, ATTACH_RECURRING, ATTACH_TEMP, ATTENDANCE_PAGE_URL, ATTENDEE_ADD_COMMENT_PAGE_URL, ATTENDEE_MEETING_PAGE_URL, ATTENDEE_USER_ID, CANCEL_ADD_MEETING_PAGE_URL, CATERGORY_FILER_ALL, COPTY_MEETING_PAGE_URL, CUSTOM_DEFINED_TIMESLOT_PAGE_URL, DATA_VERSION, dataRefreshInterval, DAY_IN_MILLISEC, DAY_IN_MINUTES, DAYS, FULL_DATA_BOTH_VERSION, FULL_VERSION, HALF_YEAR, Hour_In_MINUTES, HOURS, MAIN_EVENTS_LIST_PAGE_URL, MAX_NUM_PARTICIPANTS_FOR_DROPDOWN_BEFORE_AUTO_SWITCH_TO_EID_INPUT_MODE, MAX_NUMBER_OF_RETRY, MINUTE_IN_MILLISEC, MINUTES, MODIFY_MEETING_PAGE_URL, MOVE_ACTION, NINTY_DAYS, OLD_DAYS, ON_BOTTOM_LIST, ON_TOP_LIST, onceOnly, ORGANIZER_MEETING_PAGE_URL, perBiweek, perDay, perWeek, PRE_ASSIGN_ATTENDEE_PAGE_URL, REPLACE_ACTION, SHORT_VERSION, SIXTY_DAYS, START_NOW, SWAP_ACTION, THIRTY_DAYS, VIEW_ALL, VIEW_COMMENT_PAGE_URL, VIEW_IMMEDIATE_AVAIL, VIEW_MY_SIGNED_UP

Constructor Summary

Constructors
Constructor and Description

SignupMeetingsBean()
Default Constructor

Constructors
Constructor and Description
`SignupMeetingsBean()` Default Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`addMeeting()` This is a JSF action call method by UI to navigate to add new event/meeting page.
`List<SelectItem>`	`getAllCategories()`
`List<SelectItem>`	`getAllCategoriesForFilter()` UI method to get list of categories for the filter First item has null value to signal that it is all categories
`List<SelectItem>`	`getAllLocations()`
`List<SignupMeetingWrapper>`	`getAllSignupMeetings()` This is a getter method for UI and returns all signup meetings.
`AttendanceSignupBean`	`getAttendanceSignupBean()`
`AttendeeSignupMBean`	`getAttendeeSignupMBean()` This is a getter method.
`CreateSitesGroups`	`getCreateSitesGroups()`
`String`	`getCurrentUserDisplayName()` This is a getter method.
`String`	`getIframeId()` This is a getter method which provide current Iframe id for refresh IFrame purpose.
`String`	`getInstructorName(String userId)` Get the name of the user (instructor) for the given userId.
`List<SelectItem>`	`getInstructors(org.sakaiproject.signup.model.SignupMeeting meeting)` Get a list of instructors, defined as those with a given permission.
`UIData`	`getMeetingTable()` This is a getter method for UI.
`String`	`getMeetingUnavailableMessages()` It's a getter method for UI.
`NewSignupMeetingBean`	`getNewSignupMeetingBean()` It's getter method for JSF bean
`OrganizerSignupMBean`	`getOrganizerSignupMBean()` This is a getter method.
`org.sakaiproject.signup.logic.SakaiFacade`	`getSakaiFacade()` This is a getter method for UI.
`List<SignupMeetingWrapper>`	`getSignupMeetings()` This is a getter method for UI and filters the list according to what has been set.
`org.sakaiproject.signup.logic.SignupMeetingService`	`getSignupMeetingService()` This is a getter method.
`SignupSorter`	`getSignupSorter()` This is a getter to obtain the SignupSorter object.
`String`	`getViewDateRang()` This is a getter method for UI.
`List<SelectItem>`	`getViewDropDownList()` This is a getter method.
`boolean`	`isAllowedToCreate()`
`boolean`	`isAllowedToDelete()` This is a getter method for UI.
`boolean`	`isAllowedToUpdate()` This is a getter method for UI.
`boolean`	`isAttendanceOn()`
`boolean`	`isCategoriesAvailable()` This is a getter method for UI.
`boolean`	`isCsvExportEnabled()` Is CSV export enabled?
`boolean`	`isCurrentUserAllowedUpdateSite()` Is the current user allowed to update the site?
`boolean`	`isEnableExpandOption()` This is a getter method for UI.
`boolean`	`isLocationsAvailable()` This is a getter method for UI.
`boolean`	`isMeetingsAvailable()` This is a getter method for UI.
`boolean`	`isSelectedViewAllMeetings()` This provides information of user's View selection for UI
`boolean`	`isSelectedViewFutureMeetings()` This provides information of user's View selection for UI
`boolean`	`isSelectedViewImmediateAvail()`
`boolean`	`isSelectedViewMySignedUp()`
`boolean`	`isShowAllRecurMeetings()` This is a getter method for UI.
`boolean`	`isShowMyAppointmentTime()` For UI, it will switch the time-column accordingly
`boolean`	`isUserLoggedInStatus()`
`String`	`processExpandAllRcurEvents(ValueChangeEvent vce)` This is a ValueChange Listener to watch the show-all-recurring-events check-box value change by user.
`String`	`processSelectedCategory(ValueChangeEvent vce)` This is a ValueChange Listener to watch the category filter selection by user.
`String`	`processSelectedRange(ValueChangeEvent vce)` This is a ValueChange Listener to watch the view-range type selection by user.
`String`	`processSignup()` This is a JSF action call method by UI to navigate to view the specific event/meeting page.
`String`	`processSignupAttendance()` This is a JSF action call method by UI to navigate to view the specific event/meeting attendance page.
`String`	`removeMeetings()` This is a JSF action call method by UI to remove the selected events/meetings.
`void`	`setAttendanceSignupBean(AttendanceSignupBean attendanceSignupBean)`
`void`	`setAttendeeSignupMBean(AttendeeSignupMBean attendeeSignupMBean)` This is a setter.
`void`	`setEnableExpandOption(boolean enableExpandOption)` This is a setter method for UI.
`void`	`setMeetingTable(UIData meetingTable)` This is a setter.
`void`	`setNewSignupMeetingBean(NewSignupMeetingBean newSignupMeetingBean)` It's a setter method for JSF bean.
`void`	`setOrganizerSignupMBean(OrganizerSignupMBean organizerSignupMBean)` This is a setter.
`void`	`setSakaiFacade(org.sakaiproject.signup.logic.SakaiFacade sakaiFacade)` This is a setter.
`void`	`setShowAllRecurMeetings(boolean showAllRecurMeetings)` This is a setter method for UI.
`void`	`setSignupMeetings(List<SignupMeetingWrapper> signupMeetings)` This is a setter.
`void`	`setSignupMeetingService(org.sakaiproject.signup.logic.SignupMeetingService signupMeetingService)` This is a setter.
`void`	`setSignupSorter(SignupSorter signupSorter)` This is a setter.
`void`	`setViewDateRang(String viewDateRang)` This is a setter for UI.

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

- Field Detail
  - meetingTable
```
protected UIData meetingTable
```
  - viewDateRang
```
protected String viewDateRang
```
  - signupMeetingService
```
protected org.sakaiproject.signup.logic.SignupMeetingService signupMeetingService
```
  - signupMeetings
```
protected List<SignupMeetingWrapper> signupMeetings
```
  - sakaiFacade
```
protected org.sakaiproject.signup.logic.SakaiFacade sakaiFacade
```
  - attendeeSignupMBean
```
protected AttendeeSignupMBean attendeeSignupMBean
```
  - organizerSignupMBean
```
protected OrganizerSignupMBean organizerSignupMBean
```
  - attendanceSignupBean
```
protected AttendanceSignupBean attendanceSignupBean
```
  - signupSorter
```
protected SignupSorter signupSorter
```
  - showAllRecurMeetings
```
protected boolean showAllRecurMeetings
```
  - enableExpandOption
```
protected boolean enableExpandOption
```
  - viewDropDownList
```
protected List<SelectItem> viewDropDownList
```
  - disabledSelectView
```
protected final String disabledSelectView
```
    See Also:
    Constant Field Values
  - meetingUnavailableMessages
```
protected String meetingUnavailableMessages
```
  - categoriesExist
```
protected Boolean categoriesExist
```
  - locationsExist
```
protected Boolean locationsExist
```
  - categoryFilter
```
protected String categoryFilter
```
- Constructor Detail
  - SignupMeetingsBean
```
public SignupMeetingsBean()
```
    Default Constructor
- Method Detail
  - getCurrentUserDisplayName
```
public String getCurrentUserDisplayName()
```
    This is a getter method.
    
    Returns:
    the current user display name.
  - addMeeting
```
public String addMeeting()
```
    This is a JSF action call method by UI to navigate to add new event/meeting page.
    
    Returns:
    an action outcome string.
  - removeMeetings
```
public String removeMeetings()
```
    This is a JSF action call method by UI to remove the selected events/meetings.
    
    Returns:
    an action outcome string.
  - getAllLocations
```
public List<SelectItem> getAllLocations()
```
  - getAllCategories
```
public List<SelectItem> getAllCategories()
```
  - processSignup
```
public String processSignup()
```
    This is a JSF action call method by UI to navigate to view the specific event/meeting page.
    
    Returns:
    an action outcome string.
  - processSignupAttendance
```
public String processSignupAttendance()
```
    This is a JSF action call method by UI to navigate to view the specific event/meeting attendance page.
    
    Returns:
    an action outcome string.
  - processSelectedRange
```
public String processSelectedRange(ValueChangeEvent vce)
```
    This is a ValueChange Listener to watch the view-range type selection by user.
    
    Parameters:
    vce - a ValuechangeEvent object.
    
    Returns:
    a outcome string.
  - processExpandAllRcurEvents
```
public String processExpandAllRcurEvents(ValueChangeEvent vce)
```
    This is a ValueChange Listener to watch the show-all-recurring-events check-box value change by user.
    
    Parameters:
    vce - a ValuechangeEvent object.
    
    Returns:
    a outcome string.
  - getSakaiFacade
```
public org.sakaiproject.signup.logic.SakaiFacade getSakaiFacade()
```
    This is a getter method for UI.
    
    Returns:
    a SakaiFacade object.
  - setSakaiFacade
```
public void setSakaiFacade(org.sakaiproject.signup.logic.SakaiFacade sakaiFacade)
```
    This is a setter.
    
    Parameters:
    sakaiFacade - a SakaiFacade object.
  - getSignupMeetingService
```
public org.sakaiproject.signup.logic.SignupMeetingService getSignupMeetingService()
```
    This is a getter method.
    
    Returns:
    a SignupMeetingService object.
  - setSignupMeetingService
```
public void setSignupMeetingService(org.sakaiproject.signup.logic.SignupMeetingService signupMeetingService)
```
    This is a setter.
    
    Parameters:
    signupMeetingService - a SignupMeetingService object.
  - getSignupMeetings
```
public List<SignupMeetingWrapper> getSignupMeetings()
```
    This is a getter method for UI and filters the list according to what has been set.
    
    Returns:
    a list of SignupMeetingWrapper objects.
  - getAllSignupMeetings
```
public List<SignupMeetingWrapper> getAllSignupMeetings()
```
    This is a getter method for UI and returns all signup meetings. Ignores any filters.
    
    Returns:
    a list of SignupMeetingWrapper objects.
  - isAllowedToDelete
```
public boolean isAllowedToDelete()
```
    This is a getter method for UI.
    
    Returns:
    true if atleast one of the meeting has delete permission for the current user.
  - isAllowedToUpdate
```
public boolean isAllowedToUpdate()
```
    This is a getter method for UI.
    
    Returns:
    true if atleast one of the meeting has update permission for the current user.
  - isMeetingsAvailable
```
public boolean isMeetingsAvailable()
```
    This is a getter method for UI.
    
    Returns:
    true if atleast one of the meeting is available to the current user.
  - isCategoriesAvailable
```
public boolean isCategoriesAvailable()
```
    This is a getter method for UI.
    
    Returns:
    true if we have categories already
  - isLocationsAvailable
```
public boolean isLocationsAvailable()
```
    This is a getter method for UI.
    
    Returns:
    true if we have categories already
  - isSelectedViewFutureMeetings
```
public boolean isSelectedViewFutureMeetings()
```
    This provides information of user's View selection for UI
    
    Returns:
    true if user has select 'all future meetings' or 'all' for view
  - isSelectedViewAllMeetings
```
public boolean isSelectedViewAllMeetings()
```
    This provides information of user's View selection for UI
    
    Returns:
    true if user has select 'all meetings' or 'all' for view
  - isAllowedToCreate
```
public boolean isAllowedToCreate()
```
  - getCreateSitesGroups
```
public CreateSitesGroups getCreateSitesGroups()
```
  - setSignupMeetings
```
public void setSignupMeetings(List<SignupMeetingWrapper> signupMeetings)
```
    This is a setter.
    
    Parameters:
    signupMeetings - a list of SignupMeetingWrapper objects.
  - getMeetingTable
```
public UIData getMeetingTable()
```
    This is a getter method for UI.
    
    Returns:
    an UIData object.
  - setMeetingTable
```
public void setMeetingTable(UIData meetingTable)
```
    This is a setter.
    
    Parameters:
    meetingTable - an UIData object.
  - getAttendeeSignupMBean
```
public AttendeeSignupMBean getAttendeeSignupMBean()
```
    This is a getter method.
    
    Returns:
    an AttendeeSginupMBean object.
  - setAttendeeSignupMBean
```
public void setAttendeeSignupMBean(AttendeeSignupMBean attendeeSignupMBean)
```
    This is a setter.
    
    Parameters:
    attendeeSignupMBean - an AttendeeSignupMBean object.
  - getOrganizerSignupMBean
```
public OrganizerSignupMBean getOrganizerSignupMBean()
```
    This is a getter method.
    
    Returns:
    an OrganizerSignupMBean object
  - setOrganizerSignupMBean
```
public void setOrganizerSignupMBean(OrganizerSignupMBean organizerSignupMBean)
```
    This is a setter.
    
    Parameters:
    organizerSignupMBean - an OrganizerSignupMBean object
  - getViewDateRang
```
public String getViewDateRang()
```
    This is a getter method for UI.
    
    Returns:
    a string value.
  - setViewDateRang
```
public void setViewDateRang(String viewDateRang)
```
    This is a setter for UI.
    
    Parameters:
    viewDateRang - a string value.
  - getSignupSorter
```
public SignupSorter getSignupSorter()
```
    This is a getter to obtain the SignupSorter object.
    
    Returns:
    A SignupSorter object.
  - setSignupSorter
```
public void setSignupSorter(SignupSorter signupSorter)
```
    This is a setter.
    
    Parameters:
    signupSorter - A SignupSorter object.
  - isShowAllRecurMeetings
```
public boolean isShowAllRecurMeetings()
```
    This is a getter method for UI.
    
    Returns:
    a boolean value
  - setShowAllRecurMeetings
```
public void setShowAllRecurMeetings(boolean showAllRecurMeetings)
```
    This is a setter method for UI.
    
    Parameters:
    showAllRecurMeetings - a boolean value
  - getIframeId
```
public String getIframeId()
```
    This is a getter method which provide current Iframe id for refresh IFrame purpose.
    
    Returns:
    a String
  - isEnableExpandOption
```
public boolean isEnableExpandOption()
```
    This is a getter method for UI.
    
    Returns:
    a boolean value
  - setEnableExpandOption
```
public void setEnableExpandOption(boolean enableExpandOption)
```
    This is a setter method for UI.
    
    Parameters:
    enableExpandOption - a boolean value
  - getViewDropDownList
```
public List<SelectItem> getViewDropDownList()
```
    This is a getter method.
    
    Returns:
    a list of SelectItem which provide user's choices for view
  - getMeetingUnavailableMessages
```
public String getMeetingUnavailableMessages()
```
    It's a getter method for UI.
    
    Returns:
    a String message.
  - isSelectedViewImmediateAvail
```
public boolean isSelectedViewImmediateAvail()
```
  - isSelectedViewMySignedUp
```
public boolean isSelectedViewMySignedUp()
```
  - getNewSignupMeetingBean
```
public NewSignupMeetingBean getNewSignupMeetingBean()
```
    It's getter method for JSF bean
    
    Returns:
    a NewSignupMeetingBean object
  - setNewSignupMeetingBean
```
public void setNewSignupMeetingBean(NewSignupMeetingBean newSignupMeetingBean)
```
    It's a setter method for JSF bean.
    
    Parameters:
    newSignupMeetingBean - a NewSignupMeetingBean object
  - getAttendanceSignupBean
```
public AttendanceSignupBean getAttendanceSignupBean()
```
  - setAttendanceSignupBean
```
public void setAttendanceSignupBean(AttendanceSignupBean attendanceSignupBean)
```
  - isShowMyAppointmentTime
```
public boolean isShowMyAppointmentTime()
```
    For UI, it will switch the time-column accordingly
    
    Returns:
    a boolean value
  - isUserLoggedInStatus
```
public boolean isUserLoggedInStatus()
```
  - isAttendanceOn
```
public boolean isAttendanceOn()
```
    Returns:
    true if sakai property signup.enableAttendance is true, else will return false
  - getInstructors
```
public List<SelectItem> getInstructors(org.sakaiproject.signup.model.SignupMeeting meeting)
```
    Get a list of instructors, defined as those with a given permission. Format it as a SelectItem list with the current instructor, if any, at the top
    
    Returns:
  - getInstructorName
```
public String getInstructorName(String userId)
```
    Get the name of the user (instructor) for the given userId. This really just formats a name
    
    Parameters:
    userId -
    
    Returns:
  - isCsvExportEnabled
```
public boolean isCsvExportEnabled()
```
    Is CSV export enabled?
    
    Returns:
    true or false, depending on signup.csv.export.enabled setting.
  - isCurrentUserAllowedUpdateSite
```
public boolean isCurrentUserAllowedUpdateSite()
```
    Is the current user allowed to update the site? Used for some permission checks
    
    Returns:
  - getAllCategoriesForFilter
```
public List<SelectItem> getAllCategoriesForFilter()
```
    UI method to get list of categories for the filter First item has null value to signal that it is all categories
    
    Returns:
    list of categories
  - processSelectedCategory
```
public String processSelectedCategory(ValueChangeEvent vce)
```
    This is a ValueChange Listener to watch the category filter selection by user.
    
    Parameters:
    vce - a ValuechangeEvent object.
    
    Returns:
    a outcome string.

Class SignupMeetingsBean

Field Summary

Fields inherited from interface org.sakaiproject.signup.tool.util.SignupBeanConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

meetingTable

viewDateRang

signupMeetingService

signupMeetings

sakaiFacade

attendeeSignupMBean

organizerSignupMBean

attendanceSignupBean

signupSorter

showAllRecurMeetings

enableExpandOption

viewDropDownList

disabledSelectView

meetingUnavailableMessages

categoriesExist

locationsExist

categoryFilter

Constructor Detail

SignupMeetingsBean

Method Detail

getCurrentUserDisplayName

addMeeting

removeMeetings

getAllLocations

getAllCategories

processSignup

processSignupAttendance

processSelectedRange

processExpandAllRcurEvents

getSakaiFacade

setSakaiFacade

getSignupMeetingService

setSignupMeetingService

getSignupMeetings

getAllSignupMeetings

isAllowedToDelete

isAllowedToUpdate

isMeetingsAvailable

isCategoriesAvailable

isLocationsAvailable

isSelectedViewFutureMeetings

isSelectedViewAllMeetings

isAllowedToCreate

getCreateSitesGroups

setSignupMeetings

getMeetingTable

setMeetingTable

getAttendeeSignupMBean

setAttendeeSignupMBean

getOrganizerSignupMBean

setOrganizerSignupMBean

getViewDateRang

setViewDateRang

getSignupSorter

setSignupSorter

isShowAllRecurMeetings

setShowAllRecurMeetings

getIframeId

isEnableExpandOption

setEnableExpandOption

getViewDropDownList

getMeetingUnavailableMessages

isSelectedViewImmediateAvail

isSelectedViewMySignedUp

getNewSignupMeetingBean

setNewSignupMeetingBean

getAttendanceSignupBean

setAttendanceSignupBean

isShowMyAppointmentTime

isUserLoggedInStatus

isAttendanceOn

getInstructors

getInstructorName