es.uvigo.esei.dgss.letta.domain.entities

Class User

java.lang.Object

es.uvigo.esei.dgss.letta.domain.entities.User

All Implemented Interfaces:

Serializable

@Entity
public class User
extends Object
implements Serializable

An entity that represents an user of the application. User's represented by this entity have the USER role.

Author:

Miguel Reboiro Jato, Adolfo Álvarez López

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
User(String login, String password, String email) Constructs a new instance of User with the USER role.
User(String login, String password, String email, boolean isAdmin)
User(String login, String password, String email, String city)
User(String login, String password, String email, String completeName, String description, String fbUrl, String twUrl, String personalUrl, boolean notifications, byte[] image, String city) Constructs a new instance of User with the USER role.

Method Summary

Modifier and Type	Method and Description
void	changePassword(String password) Changes the password of the user.
boolean	equals(Object obj)
String	getCity() Gets the value of the variable city
String	getCompleteName() Returns the complete name of the user.
String	getDescription() Returns the description of the user.
String	getEmail() Returns the email of the user.
String	getFbUrl() Returns the url to the facebook profile of the user.
byte[]	getImage() Returns the image of the user's profile.
String	getLogin() Returns the login of this user.
String	getPassword() Returns the MD5 of the user's password.
String	getPersonalUrl() Returns the url to the personal page or blog of the user.
Role	getRole() Returns the role of the user.
String	getTwUrl() Returns the url to the twitter profile of the user.
int	hashCode()
boolean	isNotifications() Returns true if the User wants to recieve Notification null otherwise
void	setCity(String city) Sets the value of the variable city
void	setCompleteName(String completeName) Sets the complete name of the user.
void	setDescription(String description) Sets the description of the user.
void	setEmail(String email) Sets the email of the user.
void	setFbUrl(String fbUrl) Sets the url to the facebook profile of the user.
void	setFieldsFrom(User user)
void	setImage(byte[] image) Sets the image of the user's profile.
void	setLogin(String login) Sets the login of this user.
void	setNotifications(boolean notifications) Sets the value of the variable notifications
void	setPassword(String password) Sets the MD5 password of the user.
void	setPersonalUrl(String personalUrl) Sets the url to the personal page or blog of the user.
void	setTwUrl(String twUrl) Sets the url to the twitter profile of the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

User

public User(String login,
            String password,
            String email)

Constructs a new instance of User with the USER role.

Parameters:

login - the login of the new user. This login must be unique in the system.

password - the raw password of the user.

email - the email of the user.

User

public User(String login,
            String password,
            String email,
            String city)

User

public User(String login,
            String password,
            String email,
            boolean isAdmin)

User

public User(String login,
            String password,
            String email,
            String completeName,
            String description,
            String fbUrl,
            String twUrl,
            String personalUrl,
            boolean notifications,
            byte[] image,
            String city)

Constructs a new instance of User with the USER role.

Parameters:

login - the login of the new user. This login must be unique in the system.

password - the raw password of the user.

email - the email of the user.

completeName - the complete name of the user.

description - the description of the user.

fbUrl - the link to the user's Facebook page.

twUrl - the link to the user's Twitter page.

personalUrl - the link to the user's personal web or blog.

notifications - if the User wants Notification

image - the image of the user's profile.

Method Detail

getLogin

public String getLogin()

Returns the login of this user.

Returns:

the login of this user.

setLogin

public void setLogin(String login)

Sets the login of this user.

Parameters:

login - the login that identifies the user. This parameter must be a non empty and non null string with a maximum length of 100 chars.

Throws:

NullPointerException - if null is passed as parameter.

IllegalArgumentException - if the length of the string passed is not valid.

getPassword

public String getPassword()

Returns the MD5 of the user's password. Capital letters are used in the returned string.

Returns:

the MD5 of the user's password. Capital letters are used in the returned string.

setPassword

public void setPassword(String password)

Sets the MD5 password of the user. The MD5 string is stored with lowercase letters.

Parameters:

password - the MD5 password of the user. This parameter must be a non null MD5 string.

Throws:

NullPointerException - if null is passed as parameter.

IllegalArgumentException - if the string passed is not a valid MD5 string.

changePassword

public void changePassword(String password)

Changes the password of the user. This method receives the rawvalue of the password and stores it in MD5 format.

Parameters:

password - the raw password of the user. This parameter must be a non null string with a minimum length of 6 chars.

Throws:

NullPointerException - if the password is null.

IllegalArgumentException - if the length of the string passed is not valid.

getEmail

public String getEmail()

Returns the email of the user.

Returns:

the email of the user.

setEmail

public void setEmail(String email)

Sets the email of the user.

Parameters:

email - the email of the user.

Throws:

IllegalArgumentException - if the email provided is not a valid email.

getRole

public Role getRole()

Returns the role of the user.

Returns:

the role of the user.

setCompleteName

public void setCompleteName(String completeName)

Sets the complete name of the user.

Parameters:

completeName - the complete name of the user. This parameter can be an empty or a null string and the maximum length is 30 chars.

Throws:

IllegalArgumentException - if the length of the string passed is not valid.

getCompleteName

public String getCompleteName()

Returns the complete name of the user.

Returns:

the complete name of the user.

setDescription

public void setDescription(String description)

Sets the description of the user.

Parameters:

description - the description of the user. This parameter can be an empty or a null string and the maximum length is 1000 chars.

Throws:

IllegalArgumentException - if the length of the string passed is not valid.

getDescription

public String getDescription()

Returns the description of the user.

Returns:

the description of the user.

setFbUrl

public void setFbUrl(String fbUrl)

Sets the url to the facebook profile of the user.

Parameters:

fbUrl - the url to the facebook profile of the user.

Throws:

IllegalArgumentException - if the length of the string passed is not valid.

getFbUrl

public String getFbUrl()

Returns the url to the facebook profile of the user.

Returns:

the url to the facebook profile of the user.

setTwUrl

public void setTwUrl(String twUrl)

Sets the url to the twitter profile of the user.

Parameters:

twUrl - the url to the twitter profile of the user.

Throws:

IllegalArgumentException - if the length of the string passed is not valid.

getTwUrl

public String getTwUrl()

Returns the url to the twitter profile of the user.

Returns:

the url to the twitter profile of the user.

setPersonalUrl

public void setPersonalUrl(String personalUrl)

Sets the url to the personal page or blog of the user.

Parameters:

personalUrl - the url to the personal page or blog of the user.

Throws:

IllegalArgumentException - if the length of the string passed is not valid.

getPersonalUrl

public String getPersonalUrl()

Returns the url to the personal page or blog of the user.

Returns:

the url to the personal page or blog of the user.

setImage

public void setImage(byte[] image)

Sets the image of the user's profile.

Parameters:

image - the image of the user's profile.

getImage

public byte[] getImage()

Returns the image of the user's profile.

Returns:

the image of the user's profile.

isNotifications

public boolean isNotifications()

Returns true if the User wants to recieve Notification null otherwise

Returns:

true if the User wants to recieve Notification null otherwise

setNotifications

public void setNotifications(boolean notifications)

Sets the value of the variable notifications

Parameters:

notifications - the value of the variable

getCity

public String getCity()

Gets the value of the variable city

Returns:

the value of the variable city

setCity

public void setCity(String city)

Sets the value of the variable city

Parameters:

city - the value of the variable

setFieldsFrom

public void setFieldsFrom(User user)
                   throws NullPointerException,
                          IllegalArgumentException

Throws:

NullPointerException

IllegalArgumentException

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object