BreinUser (brein-api-library-java)

java.lang.Object
- com.brein.domain.BreinUser

```
public class BreinUser
extends java.lang.Object
```
A plain object specifying the user information the activity belongs to

Constructor Summary

Constructors
Constructor and Description

BreinUser()

BreinUser(java.lang.String email)
create a brein user with field email.

Constructors
Constructor and Description
`BreinUser()`
`BreinUser(java.lang.String email)` create a brein user with field email.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static BreinUser`	`clone(BreinUser sourceUser)` Creates a clone of a given BreinUser object
`java.util.Map<java.lang.String,java.lang.Object>`	`get()` returns the user map
`java.util.Map<java.lang.String,java.lang.Object>`	`getAdditional()` returns the user additional map
`java.lang.String`	`getDateOfBirth()` Returns the date of birth
`java.lang.String`	`getDeviceId()` retrieves the device-id
`java.lang.String`	`getEmail()` get the email of the user
`java.lang.String`	`getFirstName()` Retrieves the first name of the user
`java.lang.String`	`getImei()` Retrieves imei (International Mobile Equipment Identity)
`java.lang.String`	`getIpAddress()` retrieves the ipAddress (additional part)
`java.lang.String`	`getLastName()` Retrieves the last name of the user
`java.lang.String`	`getLocalDateTime()` get's the localDateTime
`java.lang.String`	`getReferrer()` retrieves the additional referrer value
`java.lang.String`	`getSessionId()` returns the sessionId (if set)
`java.lang.String`	`getTimezone()` gets the timezone
`java.lang.String`	`getUrl()` retrieves the additional url
`java.lang.String`	`getUserAgent()` retrieves the additional userAgent value
`void`	`prepareAdditionalFields(BreinUser breinUser, java.util.Map<java.lang.String,java.lang.Object> jsonObject)` Prepares the fields that are part of the user additional section
`void`	`prepareUserFields(BreinUser breinUser, java.util.Map<java.lang.String,java.lang.Object> jsonObject)` Prepares the fields that are part of the user section
`void`	`prepareUserRequestData(java.util.Map<java.lang.String,java.lang.Object> requestData, BreinUser breinUser)` Prepares the request on user level
`void`	`resetDateOfBirth()` resets the dateOfBirth to an empty value
`BreinUser`	`set(java.util.Map<java.lang.String,java.lang.Object> userMap)` sets the user map
`BreinUser`	`set(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> userMap)` sets the user additional fields
`BreinUser`	`setAdditional(java.util.Map<java.lang.String,java.lang.Object> additional)` sets the user additional map
`BreinUser`	`setAdditional(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> additional)` sets the user additional fields
`BreinUser`	`setDateOfBirth(int month, int day, int year)` Set's the date of birth There is no check if the month - day combination is valid, only the range for day, month and year will be checked
`BreinUser`	`setDeviceId(java.lang.String deviceId)` sets the device id
`BreinUser`	`setEmail(java.lang.String email)` sets the email of the user
`BreinUser`	`setFirstName(java.lang.String firstName)` set the first name of the user
`BreinUser`	`setImei(java.lang.String imei)` Sets the imei number
`BreinUser`	`setIpAddress(java.lang.String ipAddress)` sets the ipAddress
`BreinUser`	`setLastName(java.lang.String lastName)` set the last name of the user
`BreinUser`	`setLocalDateTime(java.lang.String localDateTime)` set's the localDateTime
`BreinUser`	`setReferrer(java.lang.String referrer)` sets the additional referrer value
`BreinUser`	`setSessionId(java.lang.String sessionId)` sets the sessionId
`BreinUser`	`setTimezone(java.lang.String timezone)` set the timezone
`BreinUser`	`setUrl(java.lang.String url)` sets the additional url
`BreinUser`	`setUserAgent(java.lang.String userAgent)` sets the additional user agent value
`java.lang.String`	`toString()` provides a nicer output of the user details

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

- Constructor Detail
  - BreinUser
```
public BreinUser(java.lang.String email)
```
    create a brein user with field email.
    
    Parameters:
    
    email - of the user
  - BreinUser
```
public BreinUser()
```
- Method Detail
  - getEmail
```
public java.lang.String getEmail()
```
    get the email of the user
    
    Returns:
    
    email
  - setEmail
```
public BreinUser setEmail(java.lang.String email)
```
    sets the email of the user
    
    Parameters:
    
    email - to set (will not be checked)
    
    Returns:
    
    this
  - getFirstName
```
public java.lang.String getFirstName()
```
    Retrieves the first name of the user
    
    Returns:
    
    first name
  - setFirstName
```
public BreinUser setFirstName(java.lang.String firstName)
```
    set the first name of the user
    
    Parameters:
    
    firstName - name to set
    
    Returns:
    
    this
  - getLastName
```
public java.lang.String getLastName()
```
    Retrieves the last name of the user
    
    Returns:
    
    last name
  - setLastName
```
public BreinUser setLastName(java.lang.String lastName)
```
    set the last name of the user
    
    Parameters:
    
    lastName - last name
    
    Returns:
    
    thi
  - getSessionId
```
public java.lang.String getSessionId()
```
    returns the sessionId (if set)
    
    Returns:
    
    sessionId
  - setSessionId
```
public BreinUser setSessionId(java.lang.String sessionId)
```
    sets the sessionId
    
    Parameters:
    
    sessionId - value of the sessionId
    
    Returns:
    
    self
  - getUserAgent
```
public java.lang.String getUserAgent()
```
    retrieves the additional userAgent value
    
    Returns:
    
    value
  - setUserAgent
```
public BreinUser setUserAgent(java.lang.String userAgent)
```
    sets the additional user agent value
    
    Parameters:
    
    userAgent - value
    
    Returns:
    
    self
  - getIpAddress
```
public java.lang.String getIpAddress()
```
    retrieves the ipAddress (additional part)
    
    Returns:
    
    ipAddress
  - setIpAddress
```
public BreinUser setIpAddress(java.lang.String ipAddress)
```
    sets the ipAddress
    
    Parameters:
    
    ipAddress - value
    
    Returns:
    
    self
  - getReferrer
```
public java.lang.String getReferrer()
```
    retrieves the additional referrer value
    
    Returns:
    
    value
  - setReferrer
```
public BreinUser setReferrer(java.lang.String referrer)
```
    sets the additional referrer value
    
    Parameters:
    
    referrer - value
    
    Returns:
    
    self
  - getUrl
```
public java.lang.String getUrl()
```
    retrieves the additional url
    
    Returns:
    
    value
  - setUrl
```
public BreinUser setUrl(java.lang.String url)
```
    sets the additional url
    
    Parameters:
    
    url - value
    
    Returns:
    
    self
  - getDateOfBirth
```
public java.lang.String getDateOfBirth()
```
    Returns the date of birth
    
    Returns:
    
    date of birth
  - setDateOfBirth
```
public BreinUser setDateOfBirth(int month,
                                int day,
                                int year)
```
    Set's the date of birth There is no check if the month - day combination is valid, only the range for day, month and year will be checked
    
    Parameters:
    
    month - (1..12)
    
    day - (1..31)
    
    year - (1900..2100)
    
    Returns:
    
    self
  - resetDateOfBirth
```
public void resetDateOfBirth()
```
    resets the dateOfBirth to an empty value
  - getImei
```
public java.lang.String getImei()
```
    Retrieves imei (International Mobile Equipment Identity)
    
    Returns:
    
    serial number as string
  - setImei
```
public BreinUser setImei(java.lang.String imei)
```
    Sets the imei number
    
    Parameters:
    
    imei - number
    
    Returns:
    
    self
  - getDeviceId
```
public java.lang.String getDeviceId()
```
    retrieves the device-id
    
    Returns:
    
    device id
  - setDeviceId
```
public BreinUser setDeviceId(java.lang.String deviceId)
```
    sets the device id
    
    Parameters:
    
    deviceId - the id of the device
    
    Returns:
    
    self
  - getLocalDateTime
```
public java.lang.String getLocalDateTime()
```
    get's the localDateTime
    
    Returns:
    
    localDateTime (e.g. "Sun 25 Dec 2016 18:15:48 GMT-0800 (PST)")
  - setLocalDateTime
```
public BreinUser setLocalDateTime(java.lang.String localDateTime)
```
    set's the localDateTime
    
    Parameters:
    
    localDateTime - contains the localdate time
    
    Returns:
    
    self
  - getTimezone
```
public java.lang.String getTimezone()
```
    gets the timezone
    
    Returns:
    
    timezone (e.g. "America/Los_Angeles")
  - setTimezone
```
public BreinUser setTimezone(java.lang.String timezone)
```
    set the timezone
    
    Parameters:
    
    timezone - timezone (e.g. "America/Los_Angeles"))
    
    Returns:
    
    self
  - get
```
public java.util.Map<java.lang.String,java.lang.Object> get()
```
    returns the user map
    
    Returns:
    
    the user map
  - set
```
public BreinUser set(java.util.Map<java.lang.String,java.lang.Object> userMap)
```
    sets the user map
    
    Parameters:
    
    userMap - map
    
    Returns:
    
    self
  - set
```
public BreinUser set(java.lang.String key,
                     java.util.Map<java.lang.String,java.lang.Object> userMap)
```
    sets the user additional fields
    
    Parameters:
    
    key - contains the key for the nested map
    
    userMap - map of fields
    
    Returns:
    
    self
  - getAdditional
```
public java.util.Map<java.lang.String,java.lang.Object> getAdditional()
```
    returns the user additional map
    
    Returns:
    
    map
  - setAdditional
```
public BreinUser setAdditional(java.util.Map<java.lang.String,java.lang.Object> additional)
```
    sets the user additional map
    
    Parameters:
    
    additional - map
    
    Returns:
    
    self
  - setAdditional
```
public BreinUser setAdditional(java.lang.String key,
                               java.util.Map<java.lang.String,java.lang.Object> additional)
```
    sets the user additional fields
    
    Parameters:
    
    key - contains the key for the nested map
    
    additional - map of fields
    
    Returns:
    
    self
  - prepareUserRequestData
```
public void prepareUserRequestData(java.util.Map<java.lang.String,java.lang.Object> requestData,
                                   BreinUser breinUser)
```
    Prepares the request on user level
    
    Parameters:
    
    requestData - contains the json request that is generated (top level)
    
    breinUser - contains the brein user data
  - prepareUserFields
```
public void prepareUserFields(BreinUser breinUser,
                              java.util.Map<java.lang.String,java.lang.Object> jsonObject)
```
    Prepares the fields that are part of the user section
    
    Parameters:
    
    breinUser - contains the brein user object
    
    jsonObject - contains the json array
  - prepareAdditionalFields
```
public void prepareAdditionalFields(BreinUser breinUser,
                                    java.util.Map<java.lang.String,java.lang.Object> jsonObject)
```
    Prepares the fields that are part of the user additional section
    
    Parameters:
    
    breinUser - contains the brein user object
    
    jsonObject - contains the json array
  - clone
```
public static BreinUser clone(BreinUser sourceUser)
```
    Creates a clone of a given BreinUser object
    
    Parameters:
    
    sourceUser - contains the original brein user
    
    Returns:
    
    a copy of the original brein user
  - toString
```
public java.lang.String toString()
```
    provides a nicer output of the user details
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    output

Class BreinUser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BreinUser

BreinUser

Method Detail

getEmail

setEmail

getFirstName

setFirstName

getLastName

setLastName

getSessionId

setSessionId

getUserAgent

setUserAgent

getIpAddress

setIpAddress

getReferrer

setReferrer

getUrl

setUrl

getDateOfBirth

setDateOfBirth

resetDateOfBirth

getImei

setImei

getDeviceId

setDeviceId

getLocalDateTime

setLocalDateTime

getTimezone

setTimezone

get

set

set

getAdditional

setAdditional

setAdditional

prepareUserRequestData

prepareUserFields

prepareAdditionalFields

clone

toString