org.sakaiproject.api.section.coursemanagement
Interface User

All Known Implementing Classes:
UserImpl, UserImpl

public interface User

Models a User for use in the Section Awareness API and the Section Manager Tool.

Author:
Josh Holtzman

Method Summary
 String getDisplayId()
           
 String getDisplayName()
           
 String getSortName()
           
 String getUserUid()
           
 

Method Detail

getUserUid

public String getUserUid()
Returns:
Returns the userUid, the unique ID returned by the authentication facade.

getSortName

public String getSortName()
Returns:
Returns the sortName, displayed when users are listed in order (for example, "Paine, Thomas" or "Wong Kar-Wai")

getDisplayId

public String getDisplayId()
Returns:
Returns the displayId, AKA "campus ID", a human-meaningful UID for the user (for example, a student ID number or an institutional email address)

getDisplayName

public String getDisplayName()
Returns:
Returns the displayName, displayed when only this user is being referred to (for example, "Thomas Paine" or "Wong Kar-Wai")