User

java.lang.Object
- com.fsc.cicerone.model.BusinessEntity
- - com.fsc.cicerone.model.User

```
public class User
extends BusinessEntity
```
An entity class that stores the data of a user.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`User.Builder` A factory for a user's object.
`static class`	`User.Columns` A utility class that contains various strings to be used as keys to communicate with the remote server.
`static class`	`User.Credentials` Class that handles user credentials.

Constructor Summary

Constructors
Constructor and Description
`User()` Default empty constructor.
`User(org.json.JSONObject jsonObject)` Create a new User object based on a JSON Object.
`User(java.lang.String json)` User's constructor.
`User(User.Builder builder)` User's constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLanguage(Language language)` Add a language to the user's languages' list if it doesn't exists, otherwise do nothing.
`boolean`	`equals(java.lang.Object o)`
`java.util.Date`	`getBirthDate()` Get the user's birth date.
`java.lang.String`	`getCellphone()` Get the user's cellphone number.
`User.Credentials`	`getCredentials()` Get the user's credentials (username and password).
`Document`	`getDocument()` Get the user's current (last added and valid) document.
`java.lang.String`	`getEmail()` Get the user's email.
`java.util.Set<Language>`	`getLanguages()` Get all the user's languages.
`java.lang.String`	`getName()` Get the user's name.
`java.lang.String`	`getPassword()` Get the user's password.
`Sex`	`getSex()` Get the user's sex.
`java.lang.String`	`getSurname()` Get the user's surname.
`java.lang.String`	`getTaxCode()` Get the user's tax code.
`java.lang.String`	`getUsername()` Get the user's username.
`UserType`	`getUserType()` Get the user's type.
`int`	`hashCode()`
`protected void`	`loadFromJSONObject(org.json.JSONObject user)` Set the BusinessEntity's properties loading them from a JSONObject.
`void`	`removeLanguage(Language language)` Remove a language from the user's languages' list if it exists, otherwise do nothing.
`void`	`setBirthDate(java.util.Date birthDate)` Set the user's birth date.
`void`	`setCellphone(java.lang.String cellphone)` Set the user's cellphone number.
`void`	`setDocument(Document document)` Set the user's current (last added and valid) document.
`void`	`setEmail(java.lang.String email)` Set the user's email.
`void`	`setName(java.lang.String name)` Set the user's name
`void`	`setPassword(java.lang.String password)` Set the user's password.
`void`	`setSex(Sex sex)` Set the user's sex.
`void`	`setSurname(java.lang.String surname)` Set the user's surname.
`void`	`setTaxCode(java.lang.String taxCode)` Set the user's tax code.
`void`	`setUserType(UserType userType)` Set the user's type.
`org.json.JSONObject`	`toJSONObject()` Convert the user to a JSON Object.
`static boolean`	`validateEmail(java.lang.String emailInput)` A function that validates a email.
`static boolean`	`validateUsername(java.lang.String usernameInput)` A function that validates a username.

Methods inherited from class com.fsc.cicerone.model.BusinessEntity
getJSONObject, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - User
```
public User()
```
    Default empty constructor.
  - User
```
public User(org.json.JSONObject jsonObject)
```
    Create a new User object based on a JSON Object. The JSON Object must contain at least the following values:
```
 
 {
     "username": "test",
     "tax_code": "testtaxcode",
     "name": "Nome",
     "surname": "Cognome",
     "password": "password",
     "email": "email@email.com",
     "user_type": "1",
     "cellphone": "0123456789",
     "birth_date": "2010-01-20",
     "sex": "male"
 }
 
 
```
    Parameters:
    
    jsonObject - The JSON object from which data will be fetched.
  - User
```
public User(java.lang.String json)
```
    User's constructor. Convert a json string to User.
    
    Parameters:
    
    json - The json string.
  - User
```
public User(User.Builder builder)
```
    User's constructor. Create a User from a Builder.
    
    Parameters:
    
    builder - The Builder.
- Method Detail
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
    
    See Also:
    
    Object.equals(Object)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
    
    See Also:
    
    Object.hashCode()
  - loadFromJSONObject
```
protected void loadFromJSONObject(org.json.JSONObject user)
```
    Description copied from class: BusinessEntity
    
    Set the BusinessEntity's properties loading them from a JSONObject.
    
    Specified by:
    
    loadFromJSONObject in class BusinessEntity
    
    Parameters:
    
    user - The JSONObject.
    
    See Also:
    
    BusinessEntity.loadFromJSONObject(JSONObject)
  - getName
```
public java.lang.String getName()
```
    Get the user's name.
    
    Returns:
    
    The user's name.
  - setName
```
public void setName(java.lang.String name)
```
    Set the user's name
    
    Parameters:
    
    name - The new user's name.
  - getSurname
```
public java.lang.String getSurname()
```
    Get the user's surname.
    
    Returns:
    
    The user's surname.
  - setSurname
```
public void setSurname(java.lang.String surname)
```
    Set the user's surname.
    
    Parameters:
    
    surname - The new user's surname.
  - getEmail
```
public java.lang.String getEmail()
```
    Get the user's email.
    
    Returns:
    
    The user's email.
  - setEmail
```
public void setEmail(java.lang.String email)
```
    Set the user's email.
    
    Parameters:
    
    email - The new user's email.
  - getPassword
```
public java.lang.String getPassword()
```
    Get the user's password.
    
    Returns:
    
    The user's password.
  - setPassword
```
public void setPassword(java.lang.String password)
```
    Set the user's password.
    
    Parameters:
    
    password - The new user's password.
  - getSex
```
public Sex getSex()
```
    Get the user's sex.
    
    Returns:
    
    The user's sex.
  - setSex
```
public void setSex(Sex sex)
```
    Set the user's sex.
    
    Parameters:
    
    sex - The new user's sex.
  - getTaxCode
```
public java.lang.String getTaxCode()
```
    Get the user's tax code.
    
    Returns:
    
    The user's tax code.
  - setTaxCode
```
public void setTaxCode(java.lang.String taxCode)
```
    Set the user's tax code.
    
    Parameters:
    
    taxCode - The new user's tax code.
  - getUsername
```
public java.lang.String getUsername()
```
    Get the user's username.
    
    Returns:
    
    The user's username.
  - getUserType
```
public UserType getUserType()
```
    Get the user's type.
    
    Returns:
    
    The user's type.
  - setUserType
```
public void setUserType(UserType userType)
```
    Set the user's type.
    
    Parameters:
    
    userType - The new user's type.
  - getCellphone
```
public java.lang.String getCellphone()
```
    Get the user's cellphone number.
    
    Returns:
    
    The user's cellphone number.
  - setCellphone
```
public void setCellphone(java.lang.String cellphone)
```
    Set the user's cellphone number.
    
    Parameters:
    
    cellphone - The new user's cellphone number.
  - getBirthDate
```
public java.util.Date getBirthDate()
```
    Get the user's birth date.
    
    Returns:
    
    The user's birth date.
  - setBirthDate
```
public void setBirthDate(java.util.Date birthDate)
```
    Set the user's birth date.
    
    Parameters:
    
    birthDate - The new user's birth date.
  - getDocument
```
public Document getDocument()
```
    Get the user's current (last added and valid) document.
    
    Returns:
    
    The user's current document.
  - setDocument
```
public void setDocument(Document document)
```
    Set the user's current (last added and valid) document.
    
    Parameters:
    
    document - The new user's current document.
  - getLanguages
```
public java.util.Set<Language> getLanguages()
```
    Get all the user's languages.
    
    Returns:
    
    A set containing all the user's languages.
  - addLanguage
```
public void addLanguage(Language language)
```
    Add a language to the user's languages' list if it doesn't exists, otherwise do nothing.
    
    Parameters:
    
    language - The language to be added.
  - removeLanguage
```
public void removeLanguage(Language language)
```
    Remove a language from the user's languages' list if it exists, otherwise do nothing.
    
    Parameters:
    
    language - The language to be removed.
  - toJSONObject
```
public org.json.JSONObject toJSONObject()
```
    Convert the user to a JSON Object.
    
    Specified by:
    
    toJSONObject in class BusinessEntity
    
    Returns:
    
    A JSON Object containing the data that were stored in the object.
  - getCredentials
```
public User.Credentials getCredentials()
```
    Get the user's credentials (username and password).
    
    Returns:
    
    A Credentials Object that contains the user's username and password.
  - validateUsername
```
public static boolean validateUsername(java.lang.String usernameInput)
```
    A function that validates a username. Check that the username is correctly formatted.
    
    Parameters:
    
    usernameInput - The username to check.
    
    Returns:
    
    True if username is valid. False if isn't.
  - validateEmail
```
public static boolean validateEmail(java.lang.String emailInput)
```
    A function that validates a email. Check that the email is correctly formatted.
    
    Parameters:
    
    emailInput - The username to check.
    
    Returns:
    
    True if email is valid. False if isn't.

Class User

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.fsc.cicerone.model.BusinessEntity

Methods inherited from class java.lang.Object

Constructor Detail

User

User

User

User

Method Detail

equals

hashCode

loadFromJSONObject

getName

setName

getSurname

setSurname

getEmail

setEmail

getPassword

setPassword

getSex

setSex

getTaxCode

setTaxCode

getUsername

getUserType

setUserType

getCellphone

setCellphone

getBirthDate

setBirthDate

getDocument

setDocument

getLanguages

addLanguage

removeLanguage

toJSONObject

getCredentials

validateUsername

validateEmail