org.sakaiproject.signup.tool.jsf

Class TimeslotWrapper

java.lang.Object

org.sakaiproject.signup.tool.jsf.TimeslotWrapper

All Implemented Interfaces:

Comparable

public class TimeslotWrapper
extends Object
implements Comparable

This class is a wrapper class for SignupTimeslot for UI purpose

Constructor Summary

Constructors

Constructor and Description
TimeslotWrapper(org.sakaiproject.signup.model.SignupTimeslot slot) Constructor
TimeslotWrapper(org.sakaiproject.signup.model.SignupTimeslot slot, String currentUserId) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttendee(org.sakaiproject.signup.model.SignupAttendee attendee, String displayName) This method performs adding attendee into current time slot.
int	compareTo(Object o)
List<AttendeeWrapper>	getAttendeeWrappers() This is a getter method for UI.
int	getAvailability() This is a getter method for UI.
boolean	getAvailableForSignup() This is a getter method for UI.
String	getCurrentUserId()
boolean	getDeleted()
AttendeeWrapper[]	getDisplayAttendees() This is a getter method for UI.
String	getErrorStyle()
String	getGroupId() Helper to get the groupId associated with a timeslot
String	getLabel() This is a getter method, which gives a formated timeslot period.
List<SelectItem>	getMoveAvailableTimeSlots() This is a getter method for UI.
org.sakaiproject.signup.model.SignupAttendee	getNewAttendee() This is a getter.
boolean	getNewlyAddedTS()
boolean	getNewTimeslotBlock()
int	getNumberOnWaitingList() This is a getter method for UI.
int	getPositionInTSlist() This is a getter method for UI (javaScript function needs it).
int	getRankingOnWaiting() This is a getter method for UI.
int	getSizeOfWaitingList() This is a getter method for UI.
List<SelectItem>	getSwapDropDownList() This is a getter method for UI.
org.sakaiproject.signup.model.SignupTimeslot	getTimeSlot() This is a getter for UI.
int	getTsMarker()
List<AttendeeWrapper>	getWaitingList() This is a getter method for UI.
boolean	isCurrentUserOnWaitingList() This is a getter method for UI.
boolean	isCurrentUserSignedUp() This is a getter method for UI.
void	removeAttendee(String attendeeUserId) This method performs removing attendee from current time slot.
void	setAttendeeWrappers(List<AttendeeWrapper> attendeeWrappers) This is a setter.
void	setCurrentUserId(String currentUserId) This is a setter.
void	setDeleted(boolean deleted)
void	setErrorStyle(String errorStyle)
void	setMoveAvailableTimeSlots(List<SelectItem> moveAvailableTimeSlots) This is a setter.
void	setNewAttendee(org.sakaiproject.signup.model.SignupAttendee newAttendee) This is a setter.
void	setPositionInTSlist(int positionInTSlist) This is a setter.
void	setRankingOnWaiting(int rankingOnWaiting) This is a setter.
void	setSwapDropDownList(List<SelectItem> swapDropDownList) This is a setter.
void	setTsMarker(int tsMarker)
void	setWaitingList(List<AttendeeWrapper> waitingList) This is a setter.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeslotWrapper

public TimeslotWrapper(org.sakaiproject.signup.model.SignupTimeslot slot)

Constructor

Parameters:

slot - a SignupTimeslot object.

TimeslotWrapper

public TimeslotWrapper(org.sakaiproject.signup.model.SignupTimeslot slot,
               String currentUserId)

Constructor

Parameters:

slot - a SignupTimeslot object.

currentUserId - a sakai unique internal user id.

Method Detail

getTimeSlot

public org.sakaiproject.signup.model.SignupTimeslot getTimeSlot()

This is a getter for UI.

Returns:

a SignupTimeslot object.

isCurrentUserSignedUp

public boolean isCurrentUserSignedUp()

This is a getter method for UI.

Returns:

true if the current user has signed up in this time slot.

isCurrentUserOnWaitingList

public boolean isCurrentUserOnWaitingList()

This is a getter method for UI.

Returns:

true if the current user is on waiting list at this time slot.

setCurrentUserId

public void setCurrentUserId(String currentUserId)

This is a setter.

Parameters:

currentUserId - an unique sakai internal user Id.

getCurrentUserId

public String getCurrentUserId()

getDisplayAttendees

public AttendeeWrapper[] getDisplayAttendees()

This is a getter method for UI.

Returns:

a list of String Objects, which hold attendee's diplay-name.

getAttendeeWrappers

public List<AttendeeWrapper> getAttendeeWrappers()

This is a getter method for UI.

Returns:

a list of AttendeeWrapper objects.

setAttendeeWrappers

public void setAttendeeWrappers(List<AttendeeWrapper> attendeeWrappers)

This is a setter.

Parameters:

attendeeWrappers - a list of AttendeeWrapper objects.

getWaitingList

public List<AttendeeWrapper> getWaitingList()

This is a getter method for UI.

Returns:

a list of AttendeeWrapper object

getSizeOfWaitingList

public int getSizeOfWaitingList()

This is a getter method for UI.

Returns:

an int value.

setWaitingList

public void setWaitingList(List<AttendeeWrapper> waitingList)

This is a setter.

Parameters:

waitingList - a list of AttendeeWrapper objects.

getAvailableForSignup

public boolean getAvailableForSignup()

This is a getter method for UI.

Returns:

true if there is spot avaiable for signing up.

getNewAttendee

public org.sakaiproject.signup.model.SignupAttendee getNewAttendee()

This is a getter.

Returns:

a SignupAttendee object.

setNewAttendee

public void setNewAttendee(org.sakaiproject.signup.model.SignupAttendee newAttendee)

This is a setter.

Parameters:

newAttendee - a SignupAttendee object.

getAvailability

public int getAvailability()

This is a getter method for UI.

Returns:

an int value.

getNumberOnWaitingList

public int getNumberOnWaitingList()

This is a getter method for UI.

Returns:

an int value.

getRankingOnWaiting

public int getRankingOnWaiting()

This is a getter method for UI.

Returns:

an int value.

setRankingOnWaiting

public void setRankingOnWaiting(int rankingOnWaiting)

This is a setter.

Parameters:

rankingOnWaiting - an int value.

getSwapDropDownList

public List<SelectItem> getSwapDropDownList()

This is a getter method for UI.

Returns:

a list of SelectItem objects.

setSwapDropDownList

public void setSwapDropDownList(List<SelectItem> swapDropDownList)

This is a setter.

Parameters:

swapDropDownList - a list of SelectItem objects.

getMoveAvailableTimeSlots

public List<SelectItem> getMoveAvailableTimeSlots()

This is a getter method for UI.

Returns:

a list of SelectItem objects.

setMoveAvailableTimeSlots

public void setMoveAvailableTimeSlots(List<SelectItem> moveAvailableTimeSlots)

This is a setter.

Parameters:

moveAvailableTimeSlots - a list of SelectItem objects.

getLabel

public String getLabel()

This is a getter method, which gives a formated timeslot period.

Returns:

a string value.

getPositionInTSlist

public int getPositionInTSlist()

This is a getter method for UI (javaScript function needs it).

Returns:

an int value.

setPositionInTSlist

public void setPositionInTSlist(int positionInTSlist)

This is a setter.

Parameters:

positionInTSlist - an int value.

addAttendee

public void addAttendee(org.sakaiproject.signup.model.SignupAttendee attendee,
               String displayName)

This method performs adding attendee into current time slot.

Parameters:

attendee - a SignupAttendee object.

displayName - a string of user display name.

removeAttendee

public void removeAttendee(String attendeeUserId)

This method performs removing attendee from current time slot.

Parameters:

attendeeUserId - a unique sakai internal user id.

compareTo

public int compareTo(Object o)
              throws ClassCastException

Specified by:

compareTo in interface Comparable

Throws:

ClassCastException

getTsMarker

public int getTsMarker()

setTsMarker

public void setTsMarker(int tsMarker)

getNewlyAddedTS

public boolean getNewlyAddedTS()

getDeleted

public boolean getDeleted()

setDeleted

public void setDeleted(boolean deleted)

getNewTimeslotBlock

public boolean getNewTimeslotBlock()

getErrorStyle

public String getErrorStyle()

setErrorStyle

public void setErrorStyle(String errorStyle)

getGroupId

public String getGroupId()

Helper to get the groupId associated with a timeslot

Returns: