org.sakaiproject.signup.tool.jsf

Class SignupUIBaseBean

java.lang.Object

org.sakaiproject.signup.tool.jsf.SignupUIBaseBean

All Implemented Interfaces:

org.sakaiproject.signup.logic.SignupMessageTypes, org.sakaiproject.signup.model.MeetingTypes, SignupBeanConstants

Direct Known Subclasses:

AttendanceSignupBean, AttendeeSignupMBean, CopyMeetingSignupMBean, EditMeetingSignupMBean, OrganizerSignupMBean, ViewCommentSignupMBean

public abstract class SignupUIBaseBean
extends Object
implements SignupBeanConstants, org.sakaiproject.signup.logic.SignupMessageTypes, org.sakaiproject.signup.model.MeetingTypes

This is a abstract base class for JSF Signup tool UIBean. It provides some must-have or common used methods such as getMeetingWrapper(), sakakFacade etc.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.sakaiproject.signup.logic.SignupCalendarHelper	calendarHelper
protected boolean	currentUserSignedup
protected String	customCategory
protected String	customLocation
protected static boolean	DEFAULT_EXPORT_TO_CALENDAR_TOOL
protected static boolean	DEFAULT_SEND_EMAIL
protected static String	ICS_MIME_TYPE
protected org.apache.commons.logging.Log	logger
protected SignupMeetingWrapper	meetingWrapper
protected Boolean	publishedSite
protected boolean	publishToCalendar
protected org.sakaiproject.signup.logic.SakaiFacade	sakaiFacade
protected boolean	sendEmail
protected String	sendEmailToSelectedPeopleOnly
protected org.sakaiproject.signup.logic.SignupMeetingService	signupMeetingService
protected TimeslotWrapper	timeslotWrapper
protected List<TimeslotWrapper>	timeslotWrappers

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

Fields inherited from interface org.sakaiproject.signup.logic.SignupMessageTypes

SEND_EMAIL_ALL_PARTICIPANTS, SEND_EMAIL_ONLY_ORGANIZER_COORDINATORS, SEND_EMAIL_ONLY_SIGNED_UP_ATTENDEES, SIGNUP_ATTENDEE_CANCEL, SIGNUP_ATTENDEE_PROMOTE, SIGNUP_ATTENDEE_SIGNUP, SIGNUP_ATTENDEE_SIGNUP_MOVE, SIGNUP_ATTENDEE_SIGNUP_REPLACE, SIGNUP_ATTENDEE_SIGNUP_SWAP, SIGNUP_CANCEL_MEETING, SIGNUP_MEETING_MODIFIED, SIGNUP_NEW_MEETING, SIGNUP_ORGANIZER_ADD, SIGNUP_ORGANIZER_REMOVE, SIGNUP_PRE_ASSIGN

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
SignupUIBaseBean()

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanUpUnusedAttachmentCopies(List<org.sakaiproject.signup.model.SignupAttachment> attachList)
List<String>	convertAttendeesToUuids(List<org.sakaiproject.signup.model.SignupAttendee> attendees)
List<String>	convertAttendeeWrappersToUuids(List<AttendeeWrapper> attendees)
void	downloadICSForMeeting()
void	downloadICSForMeetingTimeSlot(TimeslotWrapper timeslotWrapper)
String	generateGroupDescription(String meetingTitle, org.sakaiproject.signup.model.SignupTimeslot timeslot)
String	generateGroupTitle(String meetingTitle, org.sakaiproject.signup.model.SignupTimeslot timeslot)
String	getAllAttendeesEmailAddressesFormatted() Helper to get a formatted string of all attendee email addresses for all tineslots so we can use them in a mailto link
String	getAnnouncement() This is a getter method for UI.
boolean	getAnnouncementType() This is only for UI purpose to check if the event/meeting is an open session style and signup is not required.
AttachmentHandler	getAttachmentHandler()
String	getCustomCategory()
String	getCustomLocation()
boolean	getCustomTsType() This is only for UI purpose to check if the event/meeting is an individual style (manay time slots) and it requires signup.
List<String>	getEidsForEmail(String email) Get the eids assocaited with an email address, ie there may be two or more users with the same email address.
String	getGroup() This is a getter method for UI.
boolean	getGroupType() This is only for UI purpose to check if the event/meeting is an group style (only one time slot) and it requires signup.
String	getIframeId() This is a getter method which provide current Iframe id for refresh IFrame purpose.
String	getIndividual() This is a getter method for UI.
boolean	getIndividualType() This is only for UI purpose to check if the event/meeting is an individual style (manay time slots) and it requires signup.
int	getMaxAttendeesPerSlot()
int	getMaxSlots()
SignupMeetingWrapper	getMeetingWrapper() This method will get the most updated event/meeting data and handle all the wrapping process for UI.
Boolean	getPublishedSite() This is a getter method for UI
org.sakaiproject.signup.logic.SakaiFacade	getSakaiFacade() Get a SakaiFacade object.
String	getSendEmailToSelectedPeopleOnly()
boolean	getSignupAttachmentEmpty()
org.sakaiproject.signup.logic.SignupMeetingService	getSignupMeetingService() Get a SignupMeetingService object.
TimeslotWrapper	getTimeslotWrapper() Get a TimeslotWrapper object for UI.
List<TimeslotWrapper>	getTimeslotWrappers() Get a list of TimeslotWrapper objects.
String	getUserIdForEidOrEmail(String value) Gets the userId for a user, given an eid or an email address.
List<org.sakaiproject.signup.model.SignupAttendee>	getValidAttendees(List<org.sakaiproject.signup.model.SignupAttendee> attendees) Clean the list of attendees by checking that each user is valid
boolean	isCurrentUserSignedup() This is for UI purpose to see if current user has signed up in the event/meeting.
boolean	isIcsEnabled() Is ICS calendar generation enabled in the external calendaring service?
boolean	isMeetingOverRepeatPeriod(Date startTime, Date endTime, int repeatPeriodInDays)
boolean	isPublishToCalendar()
boolean	isSendEmail() Check if email should be sent away.
protected void	markerTimeslots(List<TimeslotWrapper> TimeSlotWrpList)
protected void	sendDownload(String filePath, String mimeType) Send a file for download.
protected void	sendDownloadWarning(String fileName, String warningMsg) Send a warning message to user about failed ICS file generation
void	setAttachmentHandler(AttachmentHandler attachmentHandler)
void	setCurrentUserSignedup(boolean currentUserSignedup) This is a setter.
void	setCustomCategory(String customCategory)
void	setCustomLocation(String customLocation)
void	setIframeId(String iframeId)
void	setMaxAttendeesPerSlot(int maxAttendeesPerSlot)
void	setMaxSlots(int maxSlots)
void	setMeetingWrapper(SignupMeetingWrapper meetingWrapper) This is a setter.
void	setPublishToCalendar(boolean publishToCalendar)
void	setSakaiFacade(org.sakaiproject.signup.logic.SakaiFacade sakaiFacade) This is a setter.
void	setSendEmail(boolean sendEmail) This is a setter.
void	setSendEmailToSelectedPeopleOnly(String sendEmailToSelectedPeopleOnly)
protected void	setSignupBeginDeadlineData(org.sakaiproject.signup.model.SignupMeeting meeting, int signupBegin, String signupBeginType, int signupDeadline, String signupDeadlineType) setup the event/meeting's signup begin and deadline time and validate it too
void	setSignupMeetingService(org.sakaiproject.signup.logic.SignupMeetingService signupMeetingService) This is a setter.
void	setTimeslotWrapper(TimeslotWrapper timeslotWrapper) This is a setter.
void	setTimeslotWrappers(List<TimeslotWrapper> timeslotWrappers) This is a setter.
protected String	updateMeetingwrapper(org.sakaiproject.signup.model.SignupMeeting meeting, String destinationUrl) process the new data into Meeting wrapper for UI purpose
protected void	updateSignupAttachmentWrapper(org.sakaiproject.signup.model.SignupMeeting meeting)
protected void	updateTimeSlotWrappers(SignupMeetingWrapper meetingWrapper) process new data into Timeslot wrapper for UI purpose

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sakaiFacade

protected org.sakaiproject.signup.logic.SakaiFacade sakaiFacade

signupMeetingService

protected org.sakaiproject.signup.logic.SignupMeetingService signupMeetingService

calendarHelper

protected org.sakaiproject.signup.logic.SignupCalendarHelper calendarHelper

meetingWrapper

protected SignupMeetingWrapper meetingWrapper

timeslotWrappers

protected List<TimeslotWrapper> timeslotWrappers

timeslotWrapper

protected TimeslotWrapper timeslotWrapper

currentUserSignedup

protected boolean currentUserSignedup

DEFAULT_SEND_EMAIL

protected static boolean DEFAULT_SEND_EMAIL

DEFAULT_EXPORT_TO_CALENDAR_TOOL

protected static boolean DEFAULT_EXPORT_TO_CALENDAR_TOOL

publishToCalendar

protected boolean publishToCalendar

sendEmail

protected boolean sendEmail

logger

protected org.apache.commons.logging.Log logger

publishedSite

protected Boolean publishedSite

sendEmailToSelectedPeopleOnly

protected String sendEmailToSelectedPeopleOnly

customLocation

protected String customLocation

customCategory

protected String customCategory

ICS_MIME_TYPE

protected static final String ICS_MIME_TYPE

See Also:

Constant Field Values

Constructor Detail

SignupUIBaseBean

public SignupUIBaseBean()

Method Detail

getMeetingWrapper

public SignupMeetingWrapper getMeetingWrapper()

This method will get the most updated event/meeting data and handle all the wrapping process for UI. Due to effeciency, the data is only guarantied fresh at a 10 minutes interval (defined by dataRefreshInterval value).

Returns:

a SignupMeetingWrapper object.

updateTimeSlotWrappers

protected void updateTimeSlotWrappers(SignupMeetingWrapper meetingWrapper)

process new data into Timeslot wrapper for UI purpose

updateMeetingwrapper

protected String updateMeetingwrapper(org.sakaiproject.signup.model.SignupMeeting meeting,
                          String destinationUrl)

process the new data into Meeting wrapper for UI purpose

updateSignupAttachmentWrapper

protected void updateSignupAttachmentWrapper(org.sakaiproject.signup.model.SignupMeeting meeting)

setSignupBeginDeadlineData

protected void setSignupBeginDeadlineData(org.sakaiproject.signup.model.SignupMeeting meeting,
                              int signupBegin,
                              String signupBeginType,
                              int signupDeadline,
                              String signupDeadlineType)
                                   throws Exception

setup the event/meeting's signup begin and deadline time and validate it too

Throws:

Exception

isMeetingOverRepeatPeriod

public boolean isMeetingOverRepeatPeriod(Date startTime,
                                Date endTime,
                                int repeatPeriodInDays)

setMeetingWrapper

public void setMeetingWrapper(SignupMeetingWrapper meetingWrapper)

This is a setter.

Parameters:

meetingWrapper - a SignupMeetingWrapper object.

getSakaiFacade

public org.sakaiproject.signup.logic.SakaiFacade getSakaiFacade()

Get a SakaiFacade object.

Returns:

a SakaiFacade object.

getMaxSlots

public int getMaxSlots()

Returns:

the maxSlots

setMaxSlots

public void setMaxSlots(int maxSlots)

Parameters:

maxSlots - the maxSlots to set

getMaxAttendeesPerSlot

public int getMaxAttendeesPerSlot()

Returns:

the maxAttendeesPerSlot

setMaxAttendeesPerSlot

public void setMaxAttendeesPerSlot(int maxAttendeesPerSlot)

Parameters:

maxAttendeesPerSlot - the maxAttendeesPerSlot to set

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()

Get a SignupMeetingService object.

Returns:

a SignupMeetingService object.

setSignupMeetingService

public void setSignupMeetingService(org.sakaiproject.signup.logic.SignupMeetingService signupMeetingService)

This is a setter.

Parameters:

signupMeetingService - a SignupMeetingService object.

isCurrentUserSignedup

public boolean isCurrentUserSignedup()

This is for UI purpose to see if current user has signed up in the event/meeting.

setCurrentUserSignedup

public void setCurrentUserSignedup(boolean currentUserSignedup)

This is a setter.

Parameters:

currentUserSignedup - a boolean value.

getTimeslotWrappers

public List<TimeslotWrapper> getTimeslotWrappers()

Get a list of TimeslotWrapper objects.

Returns:

a list of TimeslotWrapper objects.

setTimeslotWrappers

public void setTimeslotWrappers(List<TimeslotWrapper> timeslotWrappers)

This is a setter.

Parameters:

timeslotWrappers - a list of TimeslotWrapper objects.

getAnnouncementType

public boolean getAnnouncementType()

This is only for UI purpose to check if the event/meeting is an open session style and signup is not required.

getIndividualType

public boolean getIndividualType()

This is only for UI purpose to check if the event/meeting is an individual style (manay time slots) and it requires signup.

getGroupType

public boolean getGroupType()

This is only for UI purpose to check if the event/meeting is an group style (only one time slot) and it requires signup.

getCustomTsType

public boolean getCustomTsType()

This is only for UI purpose to check if the event/meeting is an individual style (manay time slots) and it requires signup.

getTimeslotWrapper

public TimeslotWrapper getTimeslotWrapper()

Get a TimeslotWrapper object for UI.

Returns:

an TimeslotWrapper object.

setTimeslotWrapper

public void setTimeslotWrapper(TimeslotWrapper timeslotWrapper)

This is a setter.

Parameters:

timeslotWrapper - a TimeslotWrapper object.

isSendEmail

public boolean isSendEmail()

Check if email should be sent away. This is used by organizer of an event/meeting.

Returns:

true if email should be sent away.

setSendEmail

public void setSendEmail(boolean sendEmail)

This is a setter.

Parameters:

sendEmail - a boolean value.

getIndividual

public String getIndividual()

This is a getter method for UI.

Returns:

a constant string.

getGroup

public String getGroup()

This is a getter method for UI.

Returns:

a constant string.

getAnnouncement

public String getAnnouncement()

This is a getter method for UI.

Returns:

a constant string.

getPublishedSite

public Boolean getPublishedSite()

This is a getter method for UI

Returns:

true if the site is published.

cleanUpUnusedAttachmentCopies

public void cleanUpUnusedAttachmentCopies(List<org.sakaiproject.signup.model.SignupAttachment> attachList)

getSignupAttachmentEmpty

public boolean getSignupAttachmentEmpty()

getAttachmentHandler

public AttachmentHandler getAttachmentHandler()

setAttachmentHandler

public void setAttachmentHandler(AttachmentHandler attachmentHandler)

markerTimeslots

protected void markerTimeslots(List<TimeslotWrapper> TimeSlotWrpList)

isPublishToCalendar

public boolean isPublishToCalendar()

setPublishToCalendar

public void setPublishToCalendar(boolean publishToCalendar)

getSendEmailToSelectedPeopleOnly

public String getSendEmailToSelectedPeopleOnly()

setSendEmailToSelectedPeopleOnly

public void setSendEmailToSelectedPeopleOnly(String sendEmailToSelectedPeopleOnly)

getValidAttendees

public List<org.sakaiproject.signup.model.SignupAttendee> getValidAttendees(List<org.sakaiproject.signup.model.SignupAttendee> attendees)

Clean the list of attendees by checking that each user is valid

Parameters:

attendees - List of attendees to be cleaned

Returns:

the cleaned list

getUserIdForEidOrEmail

public String getUserIdForEidOrEmail(String value)

Gets the userId for a user, given an eid or an email address. We check if it matches the eid first, then if it matches an email address. If nothing, return null.

Parameters:

value - the string to lookup, could be an eid or an email address

Returns:

the userId or null if User cannot be found

getEidsForEmail

public List<String> getEidsForEmail(String email)

Get the eids assocaited with an email address, ie there may be two or more users with the same email address. We need to be able to handle this in the UI.

Parameters:

email -

Returns:

List of eids.

generateGroupTitle

public String generateGroupTitle(String meetingTitle,
                        org.sakaiproject.signup.model.SignupTimeslot timeslot)

generateGroupDescription

public String generateGroupDescription(String meetingTitle,
                              org.sakaiproject.signup.model.SignupTimeslot timeslot)

convertAttendeesToUuids

public List<String> convertAttendeesToUuids(List<org.sakaiproject.signup.model.SignupAttendee> attendees)

convertAttendeeWrappersToUuids

public List<String> convertAttendeeWrappersToUuids(List<AttendeeWrapper> attendees)

getAllAttendeesEmailAddressesFormatted

public String getAllAttendeesEmailAddressesFormatted()

Helper to get a formatted string of all attendee email addresses for all tineslots so we can use them in a mailto link

Returns:

String of all email addresses

downloadICSForMeeting

public void downloadICSForMeeting()

downloadICSForMeetingTimeSlot

public void downloadICSForMeetingTimeSlot(TimeslotWrapper timeslotWrapper)

sendDownload

protected void sendDownload(String filePath,
                String mimeType)

Send a file for download.

Parameters:

filePath -

sendDownloadWarning

protected void sendDownloadWarning(String fileName,
                       String warningMsg)

Send a warning message to user about failed ICS file generation

Parameters:

fileName -

warningMsg -

isIcsEnabled

public boolean isIcsEnabled()

Is ICS calendar generation enabled in the external calendaring service?

Returns:

true/false

getIframeId

public String getIframeId()

This is a getter method which provide current Iframe id for refresh IFrame purpose.

Returns:

a String

setIframeId

public void setIframeId(String iframeId)

getCustomLocation

public String getCustomLocation()

setCustomLocation

public void setCustomLocation(String customLocation)

getCustomCategory

public String getCustomCategory()

setCustomCategory

public void setCustomCategory(String customCategory)