org.sakaiproject.signup.logic

Class SignupUser

java.lang.Object

org.sakaiproject.signup.logic.SignupUser

All Implemented Interfaces:

Comparable

public class SignupUser
extends Object
implements Comparable

This class is a place holder, which contains all the user necessary informaion for Signup Tool

Constructor Summary

Constructors

Constructor and Description
SignupUser(String eid, String internalUserId, String firstName, String lastName, Role role, String siteId, boolean publishedSite) Construtor

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o) for sorting purpose.
boolean	equals(Object other) check to see if the objects are equal
String	getDisplayName() get the display name: order of 'last name, first name'
String	getEid() get Sakai Enterprise Id
String	getFirstName() get first name of the user
String	getInternalUserId() get a unique Sakai internal used Id
String	getLastName() get the last name of the user
String	getMainSiteId()
Role	getUserRole() get the user Sakai Role object
int	hashCode()
boolean	isChecked()
boolean	isPublishedSite()
void	setChecked(boolean checked)
void	setMainSiteId(String mainSiteId)
void	setPublishedSite(boolean publishedSite)
void	setUserRole(Role userRole) set the user Role object

Methods inherited from class java.lang.Object

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

Constructor Detail

SignupUser

public SignupUser(String eid,
                  String internalUserId,
                  String firstName,
                  String lastName,
                  Role role,
                  String siteId,
                  boolean publishedSite)

Construtor

Parameters:

eid - an unique Sakai enterprise Id(UserId for UI)

internalUserId - an unique Sakai internal used Id(not UserId)

firstName - First Name of the user

lastName - Last Name of the user

role - a Sakai Role object

Method Detail

getEid

public String getEid()

get Sakai Enterprise Id

Returns:

a unique eid

getInternalUserId

public String getInternalUserId()

get a unique Sakai internal used Id

Returns:

a unique Sakai internal used Id

equals

public boolean equals(Object other)

check to see if the objects are equal

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Object o)

for sorting purpose. It's according to string alphabetic order. Last name comes first

Specified by:

compareTo in interface Comparable

getFirstName

public String getFirstName()

get first name of the user

Returns:

the first name of the user

getLastName

public String getLastName()

get the last name of the user

Returns:

the last name of the user

getDisplayName

public String getDisplayName()

get the display name: order of 'last name, first name'

Returns:

the display name

getUserRole

public Role getUserRole()

get the user Sakai Role object

Returns:

the Sakai user Role object

setUserRole

public void setUserRole(Role userRole)

set the user Role object

Parameters:

userRole - the user Sakai Role object

getMainSiteId

public String getMainSiteId()

setMainSiteId

public void setMainSiteId(String mainSiteId)

isPublishedSite

public boolean isPublishedSite()

setPublishedSite

public void setPublishedSite(boolean publishedSite)

isChecked

public boolean isChecked()

setChecked

public void setChecked(boolean checked)