com.paypal.sdk.models

Class PayerName

java.lang.Object

com.paypal.sdk.models.PayerName

public class PayerName
extends Object

This is a model class for PayerName type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PayerName.Builder Class to build instances of PayerName.

Constructor Summary

Constructors

Constructor and Description
PayerName() Default constructor.
PayerName(String prefix, String givenName, String surname, String middleName, String suffix, String alternateFullName, String fullName) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
String	getAlternateFullName() Getter for AlternateFullName.
String	getFullName() Getter for FullName.
String	getGivenName() Getter for GivenName.
String	getMiddleName() Getter for MiddleName.
String	getPrefix() Getter for Prefix.
String	getSuffix() Getter for Suffix.
String	getSurname() Getter for Surname.
void	setAlternateFullName(String alternateFullName) Setter for AlternateFullName.
void	setFullName(String fullName) Setter for FullName.
void	setGivenName(String givenName) Setter for GivenName.
void	setMiddleName(String middleName) Setter for MiddleName.
void	setPrefix(String prefix) Setter for Prefix.
void	setSuffix(String suffix) Setter for Suffix.
void	setSurname(String surname) Setter for Surname.
PayerName.Builder	toBuilder() Builds a new PayerName.Builder object.
String	toString() Converts this PayerName into string format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PayerName

public PayerName()

Default constructor.

PayerName

public PayerName(String prefix,
                 String givenName,
                 String surname,
                 String middleName,
                 String suffix,
                 String alternateFullName,
                 String fullName)

Initialization constructor.

Parameters:

prefix - String value for prefix.

givenName - String value for givenName.

surname - String value for surname.

middleName - String value for middleName.

suffix - String value for suffix.

alternateFullName - String value for alternateFullName.

fullName - String value for fullName.

Method Detail

getPrefix

public String getPrefix()

Getter for Prefix. The prefix, or title, to the party's name.

Returns:

Returns the String

setPrefix

public void setPrefix(String prefix)

Setter for Prefix. The prefix, or title, to the party's name.

Parameters:

prefix - Value for String

getGivenName

public String getGivenName()

Getter for GivenName. When the party is a person, the party's given, or first, name.

Returns:

Returns the String

setGivenName

public void setGivenName(String givenName)

Setter for GivenName. When the party is a person, the party's given, or first, name.

Parameters:

givenName - Value for String

getSurname

public String getSurname()

Getter for Surname. When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.

Returns:

Returns the String

setSurname

public void setSurname(String surname)

Setter for Surname. When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.

Parameters:

surname - Value for String

getMiddleName

public String getMiddleName()

Getter for MiddleName. When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.

Returns:

Returns the String

setMiddleName

public void setMiddleName(String middleName)

Setter for MiddleName. When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.

Parameters:

middleName - Value for String

getSuffix

public String getSuffix()

Getter for Suffix. The suffix for the party's name.

Returns:

Returns the String

setSuffix

public void setSuffix(String suffix)

Setter for Suffix. The suffix for the party's name.

Parameters:

suffix - Value for String

getAlternateFullName

public String getAlternateFullName()

Getter for AlternateFullName. DEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.

Returns:

Returns the String

setAlternateFullName

public void setAlternateFullName(String alternateFullName)

Setter for AlternateFullName. DEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.

Parameters:

alternateFullName - Value for String

getFullName

public String getFullName()

Getter for FullName. When the party is a person, the party's full name.

Returns:

Returns the String

setFullName

public void setFullName(String fullName)

Setter for FullName. When the party is a person, the party's full name.

Parameters:

fullName - Value for String

toString

public String toString()

Converts this PayerName into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public PayerName.Builder toBuilder()

Builds a new PayerName.Builder object. Creates the instance with the state of the current model.

Returns:

a new PayerName.Builder object