org.brapi.v2.model.core

Class BrAPIPerson

java.lang.Object

org.brapi.v2.model.core.BrAPIPerson

public class BrAPIPerson
extends Object

Person

Constructor Summary

Constructors

Constructor and Description
BrAPIPerson()

Method Summary

Modifier and Type	Method and Description
BrAPIPerson	additionalInfo(com.google.gson.JsonObject additionalInfo)
BrAPIPerson	description(String description)
BrAPIPerson	emailAddress(String emailAddress)
boolean	equals(Object o)
BrAPIPerson	externalReferences(List<BrAPIExternalReference> externalReferences)
BrAPIPerson	firstName(String firstName)
com.google.gson.JsonObject	getAdditionalInfo() Additional arbitrary info
String	getDescription() description of this person
String	getEmailAddress() email address for this person
@Valid List<BrAPIExternalReference>	getExternalReferences() Get externalReferences
String	getFirstName() Persons first name
String	getLastName() Persons last name
String	getMailingAddress() physical address of this person
String	getMiddleName() Persons middle name
String	getPersonDbId() Unique ID for a person
String	getPhoneNumber() phone number of this person
String	getUserID() A systems user ID associated with this person.
int	hashCode()
BrAPIPerson	lastName(String lastName)
BrAPIPerson	mailingAddress(String mailingAddress)
BrAPIPerson	middleName(String middleName)
BrAPIPerson	personDbId(String personDbId)
BrAPIPerson	phoneNumber(String phoneNumber)
BrAPIPerson	putAdditionalInfoItem(String key, Object additionalInfoItem)
void	setAdditionalInfo(com.google.gson.JsonObject additionalInfo)
void	setDescription(String description)
void	setEmailAddress(String emailAddress)
void	setExternalReferences(List<BrAPIExternalReference> externalReferences)
void	setFirstName(String firstName)
void	setLastName(String lastName)
void	setMailingAddress(String mailingAddress)
void	setMiddleName(String middleName)
void	setPersonDbId(String personDbId)
void	setPhoneNumber(String phoneNumber)
void	setUserID(String userID)
String	toString()
BrAPIPerson	userID(String userID)

Methods inherited from class java.lang.Object

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

Constructor Detail

BrAPIPerson

public BrAPIPerson()

Method Detail

personDbId

public BrAPIPerson personDbId(String personDbId)

getPersonDbId

public String getPersonDbId()

Unique ID for a person

Returns:

personDbId

setPersonDbId

public void setPersonDbId(String personDbId)

additionalInfo

public BrAPIPerson additionalInfo(com.google.gson.JsonObject additionalInfo)

putAdditionalInfoItem

public BrAPIPerson putAdditionalInfoItem(String key,
                                         Object additionalInfoItem)

getAdditionalInfo

public com.google.gson.JsonObject getAdditionalInfo()

Additional arbitrary info

Returns:

additionalInfo

setAdditionalInfo

public void setAdditionalInfo(com.google.gson.JsonObject additionalInfo)

description

public BrAPIPerson description(String description)

getDescription

public String getDescription()

description of this person

Returns:

description

setDescription

public void setDescription(String description)

emailAddress

public BrAPIPerson emailAddress(String emailAddress)

getEmailAddress

public String getEmailAddress()

email address for this person

Returns:

emailAddress

setEmailAddress

public void setEmailAddress(String emailAddress)

externalReferences

public BrAPIPerson externalReferences(List<BrAPIExternalReference> externalReferences)

getExternalReferences

@Valid
public @Valid List<BrAPIExternalReference> getExternalReferences()

Get externalReferences

Returns:

externalReferences

setExternalReferences

public void setExternalReferences(List<BrAPIExternalReference> externalReferences)

firstName

public BrAPIPerson firstName(String firstName)

getFirstName

public String getFirstName()

Persons first name

Returns:

firstName

setFirstName

public void setFirstName(String firstName)

lastName

public BrAPIPerson lastName(String lastName)

getLastName

public String getLastName()

Persons last name

Returns:

lastName

setLastName

public void setLastName(String lastName)

mailingAddress

public BrAPIPerson mailingAddress(String mailingAddress)

getMailingAddress

public String getMailingAddress()

physical address of this person

Returns:

mailingAddress

setMailingAddress

public void setMailingAddress(String mailingAddress)

middleName

public BrAPIPerson middleName(String middleName)

getMiddleName

public String getMiddleName()

Persons middle name

Returns:

middleName

setMiddleName

public void setMiddleName(String middleName)

phoneNumber

public BrAPIPerson phoneNumber(String phoneNumber)

getPhoneNumber

public String getPhoneNumber()

phone number of this person

Returns:

phoneNumber

setPhoneNumber

public void setPhoneNumber(String phoneNumber)

userID

public BrAPIPerson userID(String userID)

getUserID

public String getUserID()

A systems user ID associated with this person. Different from personDbId because you could have a person who is not a user of the system.

Returns:

userID

setUserID

public void setUserID(String userID)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object