org.sakaiproject.service.legacy.user
Interface UserEdit

All Superinterfaces:
Comparable, Edit, Entity, User
All Known Implementing Classes:
BaseUserDirectoryService.BaseUserEdit

public interface UserEdit
extends User, Edit

UserEdit is the core interface for the editable CHEF User object.


Field Summary
 
Fields inherited from interface org.sakaiproject.service.legacy.entity.Entity
SEPARATOR
 
Method Summary
 void setEid(String eid)
          Set the user's enterprise id.
 void setEmail(String email)
          Set the email address.
 void setFirstName(String name)
          Set the user's first name.
 void setId(String id)
          Set the user's id.
 void setLastName(String name)
          Set the user's last name.
 void setPassword(String pw)
          Set the user's password
 void setType(String type)
          Set the user type.
 
Methods inherited from interface org.sakaiproject.service.legacy.user.User
checkPassword, getCreatedBy, getCreatedTime, getDisplayName, getEid, getEmail, getFirstName, getLastName, getModifiedBy, getModifiedTime, getSortName, getType
 
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
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.Edit
getPropertiesEdit, isActiveEdit
 

Method Detail

setId

public void setId(String id)
Set the user's id. Note: this is a special purpose routine that is used only to establish the id field, when the id is null, and cannot be used to change a user's id, which is defined to be an un-changing value.


setEid

public void setEid(String eid)
Set the user's enterprise id. Must be unique among all users.

Parameters:
eid - The new eid value.

setEmail

public void setEmail(String email)
Set the email address.

Parameters:
email - The email address string.

setFirstName

public void setFirstName(String name)
Set the user's first name.

Parameters:
name - The user's first name.

setLastName

public void setLastName(String name)
Set the user's last name.

Parameters:
name - The user's last name.

setPassword

public void setPassword(String pw)
Set the user's password

Parameters:
pw - The user's new password.

setType

public void setType(String type)
Set the user type.

Parameters:
type - The user type.