User (Domain 0.3.0-SNAPSHOT API)

java.lang.Object
- es.uvigo.esei.dgss.teama.letta.entities.User

```
@Entity(name="User")
public class User
extends Object
```
Class that contains everything related to an user.

Author:

Rubén Anido Bande

Constructor Summary

Constructors
Constructor and Description
`User()`
`User(String login, String name, String surname, String password, String email, Role role)` Creates a new instance of `User`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttendeeToEvent(Event event)` Set this user to the event as attendee.
`void`	`addEvent(Event event)` Set this user to the event as creator.
`void`	`addOrganizerToEvent(Event event)` Set this user to the event as organizer.
`boolean`	`equals(Object obj)`
`Set<Event>`	`getAttendedEvents()` Returns events attended by the user.
`String`	`getEmail()` Returns the email of this user.
`Set<Event>`	`getEventsCreated()` Returns events created by the user.
`String`	`getLogin()` Returns the login of this user.
`String`	`getName()` Returns the name of this user.
`Set<Event>`	`getOrganizedEvents()` Returns events organized by the user.
`String`	`getPassword()` Returns the MD5 of the user's password.
`Role`	`getRole()` Returns the role of the event.
`String`	`getSurname()` Returns the surname of this user.
`int`	`hashCode()`
`boolean`	`ownsAttendedEvents(Event event)` Checks if an attendee of an event is this user.
`boolean`	`ownsCreatedEvents(Event event)` Checks if the creator of an event is this user.
`boolean`	`ownsOrganizedEvents(Event event)` Checks if the organizer of an event is this user.
`void`	`removeAttendeeToEvent(Event event)` Remove this user as attendee of the event
`void`	`setEmail(String email)` Sets the email of the user.
`void`	`setLogin(String login)` Sets the login of this user.
`void`	`setName(String name)` Sets the name of this user.
`void`	`setPassword(String password)` Changes the password of the user.
`void`	`setPasswordMD5(String password)` Sets the MD5 password of the user.
`void`	`setRole(Role role)` Sets the role of this event.
`void`	`setSurname(String surname)` Sets the surname of this 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 name,
            String surname,
            String password,
            String email,
            Role role)
```
    Creates a new instance of 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.
    
    name - the name of the event. This parameter must be a non empty and non null string with a maximum length of 100 chars.
    
    surname - the surname of the event. This parameter must be a non empty and non null string with a maximum length of 150 chars.
    
    password - the raw password of the user. This parameter must be a non null string with a minimum length of 6 chars and with a maximum length of 100 chars.
    
    email - the email of the event. This parameter must be a valid email, non empty and non null string with a maximum length of 255 chars.
    
    role - the role of the event. This parameter is an enumerated of type Role that must be a non null.
    
    Throws:
    
    NullPointerException - if a null value is passed as the value for any parameter.
    
    IllegalArgumentException - if value provided for any parameter is not valid according to its description.
  - User
```
public User()
```
- 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.
  - getName
```
public String getName()
```
    Returns the name of this user.
    
    Returns:
    
    the name of this user.
  - setName
```
public void setName(String name)
```
    Sets the name of this user.
    
    Parameters:
    
    name - the name of this 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.
  - getSurname
```
public String getSurname()
```
    Returns the surname of this user.
    
    Returns:
    
    the surname of this user.
  - setSurname
```
public void setSurname(String surname)
```
    Sets the surname of this user.
    
    Parameters:
    
    surname - the surname of this user. This parameter must be a non empty and non null string with a maximum length of 150 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.
  - setPasswordMD5
```
public void setPasswordMD5(String password)
```
    Sets the MD5 password of the user. The MD5 string is stored with capital 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.
  - setPassword
```
public void setPassword(String password)
```
    Changes the password of the user. This method receives the raw-value 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 this user.
    
    Returns:
    
    the email of this user.
  - setEmail
```
public void setEmail(String email)
```
    Sets the email of the user. The email string must be a valid email.
    
    Parameters:
    
    email - the email of the user. This parameter must be a valid email string, non empty and non null string with a maximum length of 100 chars.
    
    Throws:
    
    NullPointerException - if null is passed as parameter.
    
    IllegalArgumentException - if the string passed is not a valid email string.
  - getRole
```
public Role getRole()
```
    Returns the role of the event.
    
    Returns:
    
    the role of the event.
  - setRole
```
public void setRole(Role role)
```
    Sets the role of this event.
    
    Parameters:
    
    role - the new role of the event. This parameter is an enumerated of type Role that must be a non null.
    
    Throws:
    
    NullPointerException - if a null value is passed.
  - addEvent
```
public void addEvent(Event event)
```
    Set this user to the event as creator.
    
    Parameters:
    
    event - an event already created. null values not supported.
    
    Throws:
    
    NullPointerException - if the event is null.
  - addOrganizerToEvent
```
public void addOrganizerToEvent(Event event)
```
    Set this user to the event as organizer.
    
    Parameters:
    
    event - an event already created. null values not supported.
    
    Throws:
    
    NullPointerException - if the event is null.
  - addAttendeeToEvent
```
public void addAttendeeToEvent(Event event)
```
    Set this user to the event as attendee.
    
    Parameters:
    
    event - an event already created. null values not supported.
    
    Throws:
    
    NullPointerException - if the event is null.
  - removeAttendeeToEvent
```
public void removeAttendeeToEvent(Event event)
```
    Remove this user as attendee of the event
    
    Parameters:
    
    event - an event already created. null values not supported.
    
    Throws:
    
    NullPointerException - if the event is null.
  - getEventsCreated
```
public Set<Event> getEventsCreated()
```
    Returns events created by the user.
    
    Returns:
    
    events created by the user in a Set collection.
  - getOrganizedEvents
```
public Set<Event> getOrganizedEvents()
```
    Returns events organized by the user.
    
    Returns:
    
    events organized by the user in a Set collection.
  - getAttendedEvents
```
public Set<Event> getAttendedEvents()
```
    Returns events attended by the user.
    
    Returns:
    
    events attended by the user in a Set collection.
  - ownsOrganizedEvents
```
public boolean ownsOrganizedEvents(Event event)
```
    Checks if the organizer of an event is this user.
    
    Parameters:
    
    event - the event whose property will be checked.
    
    Returns:
    
    true if the organizer of an event is this user. false otherwise.
  - ownsCreatedEvents
```
public boolean ownsCreatedEvents(Event event)
```
    Checks if the creator of an event is this user.
    
    Parameters:
    
    event - the event whose property will be checked.
    
    Returns:
    
    true if the creator of an event is this user. false otherwise.
  - ownsAttendedEvents
```
public boolean ownsAttendedEvents(Event event)
```
    Checks if an attendee of an event is this user.
    
    Parameters:
    
    event - the event whose property will be checked.
    
    Returns:
    
    true if an attendee of an event is this user. false otherwise.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class User

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

User

User

Method Detail

getLogin

setLogin

getName

setName

getSurname

setSurname

getPassword

setPasswordMD5

setPassword

getEmail

setEmail

getRole

setRole

addEvent

addOrganizerToEvent

addAttendeeToEvent

removeAttendeeToEvent

getEventsCreated

getOrganizedEvents

getAttendedEvents

ownsOrganizedEvents

ownsCreatedEvents

ownsAttendedEvents

hashCode

equals