org.sakaiproject.service.legacy.user
Interface User

All Superinterfaces:
Comparable, Entity
All Known Subinterfaces:
UserEdit
All Known Implementing Classes:
BaseUserDirectoryService.BaseUserEdit

public interface User
extends Entity, Comparable

User is the core interface for the Sakai User object.

User objects hold everything we know about Sakai users (except for their authentication password).


Field Summary
 
Fields inherited from interface org.sakaiproject.service.legacy.entity.Entity
SEPARATOR
 
Method Summary
 boolean checkPassword(String pw)
          Check if this is the user's password.
 User getCreatedBy()
           
 Time getCreatedTime()
           
 String getDisplayName()
          Access the user's name for display purposes.
 String getEid()
          Access the user's enterprise id; the id they and the enterprise know as belonging to them.
 String getEmail()
          Access the email address.
 String getFirstName()
          Access the user's first name.
 String getLastName()
          Access the user's last name.
 User getModifiedBy()
           
 Time getModifiedTime()
           
 String getSortName()
          Access the user's name for sorting purposes.
 String getType()
          Access the user type.
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.Entity
getId, getProperties, getReference, getReference, getUrl, getUrl, toXml
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getCreatedBy

public User getCreatedBy()
Returns:
the user who created this.

getModifiedBy

public User getModifiedBy()
Returns:
the user who last modified this.

getCreatedTime

public Time getCreatedTime()
Returns:
the time created.

getModifiedTime

public Time getModifiedTime()
Returns:
the time last modified.

getEmail

public String getEmail()
Access the email address.

Returns:
The email address string.

getDisplayName

public String getDisplayName()
Access the user's name for display purposes.

Returns:
The user's name for display purposes.

getSortName

public String getSortName()
Access the user's name for sorting purposes.

Returns:
The user's name for sorting purposes.

getFirstName

public String getFirstName()
Access the user's first name.

Returns:
The user's first name.

getLastName

public String getLastName()
Access the user's last name.

Returns:
The user's last name.

checkPassword

public boolean checkPassword(String pw)
Check if this is the user's password.

Parameters:
pw - The clear text password to check.
Returns:
true if the password matches, false if not.

getType

public String getType()
Access the user type.

Returns:
The user type.

getEid

public String getEid()
Access the user's enterprise id; the id they and the enterprise know as belonging to them.
The Enterprise id, like the User id, is unique among all defined users.
The EID may be used by the user to login, and will be used when communicating with the user directory provider.

Returns:
The user's enterprise id.