org.exoplatform.services.organization

Interface User

public interface User

Created by The eXo Platform SAS Author : Mestrallet Benjamin benjmestrallet@users.sourceforge.net Date: Aug 21, 2003 Time: 3:22:54 PM This is the interface for a User data model. The OrganizationService implementor can use the different strategy to implement this class, he can use the native field for each get method or use a Map to hold the user data. The developer needs to call UserHandler.saveUser(User, boolean) to persist the change.

Level API:

Platform

Method Summary

Methods

Modifier and Type	Method and Description
Date	getCreatedDate()
String	getDisplayName()
String	getEmail()
String	getFirstName()
String	getFullName() Deprecated. This method call getDiplayName
Date	getLastLoginTime()
String	getLastName()
String	getOrganizationId()
String	getPassword()
String	getUserName() This method should return the username of the user.
void	setCreatedDate(Date t) Deprecated. The third party should not used this method.
void	setDisplayName(String displayName)
void	setEmail(String s)
void	setFirstName(String s)
void	setFullName(String s) Deprecated. This method call setDiplayName
void	setLastLoginTime(Date t) Deprecated. The third party developer should not aware of this method
void	setLastName(String s)
void	setOrganizationId(String organizationId) sets the organizationId
void	setPassword(String s) This method is used to change the user account password.
void	setUserName(String s) Deprecated. The third party developer should not used this method

Method Detail

getUserName

String getUserName()

This method should return the username of the user. The username should be unique and the user database should not have 2 user record with the same username

Returns:

the name of the user account

setUserName

void setUserName(String s)

Deprecated. The third party developer should not used this method

This method is used to change the username

Parameters:

s - the name of the user account

getPassword

String getPassword()

Returns:

This method return the password of the user account

setPassword

void setPassword(String s)

This method is used to change the user account password.

Parameters:

s - the password of the user account

getFirstName

String getFirstName()

Returns:

This method return the first name of the user

setFirstName

void setFirstName(String s)

Parameters:

s - the new first name

getLastName

String getLastName()

Returns:

The last name of the user

setLastName

void setLastName(String s)

Parameters:

s - The new last name of the user

getFullName

String getFullName()

Deprecated. This method call getDiplayName

Returns:

return the full name of the user. The full name should have the format: first name, last name by default

setFullName

void setFullName(String s)

Deprecated. This method call setDiplayName

Parameters:

s - The name that should show in the full name

getEmail

String getEmail()

Returns:

The email address of the user

setEmail

void setEmail(String s)

Parameters:

s - The new user email address

getCreatedDate

Date getCreatedDate()

Returns:

the creation date of the user account

setCreatedDate

void setCreatedDate(Date t)

Deprecated. The third party should not used this method.

Parameters:

t - the creation date of the user account

getLastLoginTime

Date getLastLoginTime()

Returns:

Returns the date corresponding to the last time that the user signed in to the platform

setLastLoginTime

void setLastLoginTime(Date t)

Deprecated. The third party developer should not aware of this method

Parameters:

t - the date corresponding to the last time that the user signed in to the platform

getDisplayName

String getDisplayName()

Returns:

return the display name

setDisplayName

void setDisplayName(String displayName)

Parameters:

displayName - The name that should show in the display name

getOrganizationId

String getOrganizationId()

Returns:

returns the id of organization to which the user belong or null if not applicable

setOrganizationId

void setOrganizationId(String organizationId)

sets the organizationId

Parameters:

organizationId - the id of organization to which the user belong