com.brein.domain

Class BreinUser

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BreinUser.UserField This list may not be complete it just contains some values.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADDITIONAL_FIELD
static java.lang.String	USER_FIELD

Constructor Summary

Constructors

Constructor and Description
BreinUser()

Method Summary

Modifier and Type	Method and Description
<T> T	get(java.lang.String key)
<T> T	get(java.lang.String key, boolean additional)
<T> T	getAdditional(java.lang.String key)
java.lang.String	getDateOfBirth() Returns the date of birth
java.lang.String	getEmail() get the email of the user
java.lang.String	getFirstName() Retrieves the first name of the user
java.lang.String	getLastName() Retrieves the last name of the user
java.lang.String	getSessionId() returns the sessionId (if set)
protected <T> T	getUserField(BreinUser.UserField field)
void	prepareRequestData(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData)
BreinUser	set(java.lang.String key, java.lang.Object value) Sets the users value and overrides any current value.
BreinUser	setAdditional(java.lang.String key, java.lang.Object value) Sets an additional value.
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	setDateOfBirth(java.lang.String dateOfBirthString) Sets the value of dateOfBirth as String.
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	setLastName(java.lang.String lastName) set the last name of the user
BreinUser	setSessionId(java.lang.String sessionId) sets the sessionId
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

Field Detail

USER_FIELD

public static final java.lang.String USER_FIELD

See Also:

Constant Field Values

ADDITIONAL_FIELD

public static final java.lang.String ADDITIONAL_FIELD

See Also:

Constant Field Values

Constructor Detail

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

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

setDateOfBirth

public BreinUser setDateOfBirth(java.lang.String dateOfBirthString)

Sets the value of dateOfBirth as String. This is only used internally.

Parameters:

dateOfBirthString - contains the date of birth string

Returns:

self

set

public BreinUser set(java.lang.String key,
                     java.lang.Object value)

Sets the users value and overrides any current value. Cannot used to override the additional field.

Parameters:

key - the name of the value to be set

value - the value to be set

Returns:

self

get

public <T> T get(java.lang.String key)

get

public <T> T get(java.lang.String key,
                 boolean additional)

getAdditional

public <T> T getAdditional(java.lang.String key)

setAdditional

public BreinUser setAdditional(java.lang.String key,
                               java.lang.Object value)

Sets an additional value.

Parameters:

key - the name of the additional value to be set

value - the value to be set

Returns:

self

prepareRequestData

public void prepareRequestData(BreinConfig config,
                               java.util.Map<java.lang.String,java.lang.Object> requestData)

toString

public java.lang.String toString()

provides a nicer output of the user details

Overrides:

toString in class java.lang.Object

Returns:

output

getUserField

protected <T> T getUserField(BreinUser.UserField field)