org.sakaiproject.signup.tool.util

Class Utilities

java.lang.Object

org.sakaiproject.signup.tool.util.Utilities

All Implemented Interfaces:

org.sakaiproject.signup.model.MeetingTypes, SignupBeanConstants

public final class Utilities
extends Object
implements SignupBeanConstants, org.sakaiproject.signup.model.MeetingTypes

This Utility class provides the common used logic by Signup tool.

Author:

Peter Liu

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	logger
static String	MESSAGE_UIBEAN Defined a constant name for ,essageUIBean
static org.sakaiproject.util.ResourceLoader	rb Get the resource bundle for messages.properties file
static org.sakaiproject.util.ResourceLoader	rbConf Get the resource bundle for signupConfig.properties file

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.model.MeetingTypes

ANNOUNCEMENT, BIWEEKLY, CUSTOM_TIMESLOTS, DAILY, GROUP, INDIVIDUAL, ONCE_ONLY, WEEKDAYS, WEEKLY

Constructor Summary

Constructors

Constructor and Description
Utilities()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addErrorMessage(String errorMsg) Add the error message to mssageUIBean for UI purpose.
static void	addInfoMessage(String infoMsg) Add the info message to messageUIBean for UI purpose.
static List<SelectItem>	getMeetingTypeSelectItems(String mSelectedType, boolean disableNotSelectedOnes) It provides a list of meeting type choices for user.
static int	getRelativeTimeValue(String timeScaleType, long timeLength) Get the relative time value according to the time unit type.
static String	getRequestParam(String attrName) This method will retrieve the value from Request object by the Request parameter/attribute name
static String	getSelectedCoordinators(List<org.sakaiproject.signup.logic.SignupUser> coordinators, String organizerId) Turn list of signup users into list of ids for storage into db.
static boolean	getSignupConfigParamVal(String paramname, boolean defaultValue) Gets a boolean value for a configuration, instead of a string value.
static String	getSignupConfigParamVal(String paramName, String defaultValue)
static SignupMeetingsBean	getSignupMeetingsBean() Get the SignupMeetingsBean in JSF as a session bean
static String	getTimeScaleType(long timeLength) Get the Signup tool defined time unit type.
static Date	getUserDefinedDate(int days) This method will convert int days to a Date object
static boolean	isDataIntegritySafe(boolean isUserDefinedTS, String callerBeanType, UserDefineTimeslotBean uBean)
static void	postEventTracking(String mainSignupEventType, String eventActionInfo) This method will post user action event to DB by using Sakai-event-tracking mechanism.
static Date	reAllocateTimeslots(Date startTime, int timeSlotDuration, int numOfTimeslot, List<org.sakaiproject.signup.model.SignupTimeslot> tsList) Relocate the timeslots in the event/meeting around according to the new data.
static void	resetMeetingList() Reset the meetings in the SignupMeetingsBean to null so we will fetch all the up-to-date meeting data again
static String	retrieveAvailStatus(org.sakaiproject.signup.model.SignupMeeting meeting, String currentUserId, org.sakaiproject.signup.logic.SakaiFacade sakaiFacade) It will obtain user current sign-up status in an event.
static Date	subTractTimeToDate(Date date, int time, String dateType) Calculate the time according to the input parameters.
static boolean	testSignupBeginStartNowType(List<org.sakaiproject.signup.model.SignupMeeting> recurringMeetings) This method will determine whether the recurring events have been previously setup by 'Start_Now' type.

Methods inherited from class java.lang.Object

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

Field Detail

rb

public static org.sakaiproject.util.ResourceLoader rb

Get the resource bundle for messages.properties file

rbConf

public static org.sakaiproject.util.ResourceLoader rbConf

Get the resource bundle for signupConfig.properties file

MESSAGE_UIBEAN

public static final String MESSAGE_UIBEAN

Defined a constant name for ,essageUIBean

See Also:

Constant Field Values

logger

protected static org.apache.commons.logging.Log logger

Constructor Detail

Utilities

public Utilities()

Method Detail

addErrorMessage

public static void addErrorMessage(String errorMsg)

Add the error message to mssageUIBean for UI purpose.

Parameters:

errorMsg - a error message string.

addInfoMessage

public static void addInfoMessage(String infoMsg)

Add the info message to messageUIBean for UI purpose.

Parameters:

infoMsg - an info message string.

getRequestParam

public static String getRequestParam(String attrName)

This method will retrieve the value from Request object by the Request parameter/attribute name

Parameters:

attrName - a string value

Returns:

a string value

resetMeetingList

public static void resetMeetingList()

Reset the meetings in the SignupMeetingsBean to null so we will fetch all the up-to-date meeting data again

getSignupMeetingsBean

public static SignupMeetingsBean getSignupMeetingsBean()

Get the SignupMeetingsBean in JSF as a session bean

Returns:

a SignupMeetingsBean JSF object

reAllocateTimeslots

public static Date reAllocateTimeslots(Date startTime,
                       int timeSlotDuration,
                       int numOfTimeslot,
                       List<org.sakaiproject.signup.model.SignupTimeslot> tsList)

Relocate the timeslots in the event/meeting around according to the new data.

Parameters:

startTime - a Date object.

timeSlotDuration - an int value, which indicate the length of the time slot.

numOfTimeslot - an int value, which indicate how many time slots are there.

tsList - a list of SignupTimeslot objects. This object is a reference object and after this call, it will hold the relocated new data.

Returns:

a Date object, which holds the ending time of the event/meeting.

subTractTimeToDate

public static Date subTractTimeToDate(Date date,
                      int time,
                      String dateType)

Calculate the time according to the input parameters.

Parameters:

date - a Date object.

time - an int value.

dateType - a string value.

Returns:

a converted Date object according to the input parameters.

getTimeScaleType

public static String getTimeScaleType(long timeLength)

Get the Signup tool defined time unit type.

Parameters:

timeLength - a long value.

Returns:

a time unit value string such as 'hours', 'minutes' and 'days'.

getRelativeTimeValue

public static int getRelativeTimeValue(String timeScaleType,
                       long timeLength)

Get the relative time value according to the time unit type.

Parameters:

timeScaleType - a string value.

timeLength - a long value

Returns:

a int value.

testSignupBeginStartNowType

public static boolean testSignupBeginStartNowType(List<org.sakaiproject.signup.model.SignupMeeting> recurringMeetings)

This method will determine whether the recurring events have been previously setup by 'Start_Now' type.

Parameters:

recurringMeetings - a list of SignupMeeting objects.

Returns:

true if the events have been set up as 'start_now' type previously

getMeetingTypeSelectItems

public static List<SelectItem> getMeetingTypeSelectItems(String mSelectedType,
                                         boolean disableNotSelectedOnes)

It provides a list of meeting type choices for user.

Parameters:

mSelectedType - a String value, which indicates that the passed-in meeting type will not disabled.

disableNotSelectedOnes - a boolean value which indicate whether to disable other meeting types except this one.

Returns:

a list of SelectItem objects.

postEventTracking

public static void postEventTracking(String mainSignupEventType,
                     String eventActionInfo)

This method will post user action event to DB by using Sakai-event-tracking mechanism. This event tracking can be turned off by setting value of post.eventTracking.info.to.DB in message.properties file to false

Parameters:

mainSignupEventType - a sign-up event type string

eventActionInfo - a detailed action info string

retrieveAvailStatus

public static String retrieveAvailStatus(org.sakaiproject.signup.model.SignupMeeting meeting,
                         String currentUserId,
                         org.sakaiproject.signup.logic.SakaiFacade sakaiFacade)

It will obtain user current sign-up status in an event.

Parameters:

meeting - a SignupMeeting object

currentUserId - a unique user internal id.

sakaiFacade - a SakaiFacade object

Returns:

a String object

getUserDefinedDate

public static Date getUserDefinedDate(int days)

This method will convert int days to a Date object

Parameters:

days - it indicates how many days from current time into the future

Returns:

a Date object

getSignupConfigParamVal

public static String getSignupConfigParamVal(String paramName,
                             String defaultValue)

getSignupConfigParamVal

public static boolean getSignupConfigParamVal(String paramname,
                              boolean defaultValue)

Gets a boolean value for a configuration, instead of a string value.

Parameters:

paramname - the name of the config parameter

defaultValue - the default boolean value to use

Returns:

true if and only if the config parameter is "true".

isDataIntegritySafe

public static boolean isDataIntegritySafe(boolean isUserDefinedTS,
                          String callerBeanType,
                          UserDefineTimeslotBean uBean)

getSelectedCoordinators

public static String getSelectedCoordinators(List<org.sakaiproject.signup.logic.SignupUser> coordinators,
                             String organizerId)

Turn list of signup users into list of ids for storage into db. SIGNUP-216 removed the restriction that an organizer cannot be in this list (unsure why they couldnt since they have the option of being chosen but are then removed?)

Parameters:

coordinators -

organizerId -

Returns: