Package com.commercetools.api.models.common

Class BaseAddressImpl

java.lang.Object

com.commercetools.api.models.common.BaseAddressImpl

All Implemented Interfaces:

BaseAddress, BaseAddressMixin, WithKey, io.vrap.rmf.base.client.ModelBase

public class BaseAddressImpl
extends Object
implements BaseAddress, io.vrap.rmf.base.client.ModelBase

Polymorphic base type that represents a postal address and contact details. Depending on the read or write action, it can be either Address or AddressDraft that only differ in the data type for the optional custom field.

Nested Class Summary

Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase

io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle

Constructor Summary

Constructors

Constructor	Description
BaseAddressImpl()	create empty instance

Method Summary

Modifier and Type	Method	Description
BaseAddress	copyDeep()
boolean	equals(Object o)
String	getAdditionalAddressInfo()	Further information on the Address.
String	getAdditionalStreetInfo()	Further information on the street address.
String	getApartment()	Number or name of the apartment.
String	getBuilding()	Number or name of the building.
String	getCity()	Name of the city.
String	getCompany()	Name of the company.
String	getCountry()	Name of the country.
String	getDepartment()	Name of the department.
String	getEmail()	Email address of the contact.
String	getExternalId()	ID for the contact used in an external system.
String	getFax()	Fax number of the contact.
String	getFirstName()	Given name (first name) of the contact.
String	getId()	Unique identifier of the Address.
String	getKey()	User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, and itemShippingAddresses (LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.
String	getLastName()	Family name (last name) of the contact.
String	getMobile()	Mobile phone number of the contact.
String	getPhone()	Phone number of the contact.
String	getPOBox()	Post office box number.
String	getPostalCode()	Postal code.
String	getRegion()	Name of the region.
String	getSalutation()	Salutation of the contact, for example 'Mr.' or 'Ms.'
String	getState()	Name of the state, for example, Colorado.
String	getStreetName()	Name of the street.
String	getStreetNumber()	Street number.
String	getTitle()	Title of the contact, for example 'Dr.'
int	hashCode()
void	setAdditionalAddressInfo(String additionalAddressInfo)	Further information on the Address.
void	setAdditionalStreetInfo(String additionalStreetInfo)	Further information on the street address.
void	setApartment(String apartment)	Number or name of the apartment.
void	setBuilding(String building)	Number or name of the building.
void	setCity(String city)	Name of the city.
void	setCompany(String company)	Name of the company.
void	setCountry(String country)	Name of the country.
void	setDepartment(String department)	Name of the department.
void	setEmail(String email)	Email address of the contact.
void	setExternalId(String externalId)	ID for the contact used in an external system.
void	setFax(String fax)	Fax number of the contact.
void	setFirstName(String firstName)	Given name (first name) of the contact.
void	setId(String id)	Unique identifier of the Address.
void	setKey(String key)	User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, and itemShippingAddresses (LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.
void	setLastName(String lastName)	Family name (last name) of the contact.
void	setMobile(String mobile)	Mobile phone number of the contact.
void	setPhone(String phone)	Phone number of the contact.
void	setPOBox(String pOBox)	Post office box number.
void	setPostalCode(String postalCode)	Postal code.
void	setRegion(String region)	Name of the region.
void	setSalutation(String salutation)	Salutation of the contact, for example 'Mr.' or 'Ms.'
void	setState(String state)	Name of the state, for example, Colorado.
void	setStreetName(String streetName)	Name of the street.
void	setStreetNumber(String streetNumber)	Street number.
void	setTitle(String title)	Title of the contact, for example 'Dr.'
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.commercetools.api.models.common.BaseAddress

withBaseAddress

Methods inherited from interface com.commercetools.api.models.common.BaseAddressMixin

equalsIgnoreId, toDraft, toDraftBuilder

Methods inherited from interface io.vrap.rmf.base.client.ModelBase

reflectionString, reflectionString

Constructor Details

BaseAddressImpl

public BaseAddressImpl()

create empty instance

Method Details

getId

public String getId()

Unique identifier of the Address.

It is not recommended to set it manually since the API overwrites this ID when creating an Address for a Customer. Use key instead and omit this field from the request to let the API generate the ID for the Address.

Specified by:

getId in interface BaseAddress

Returns:

id

getKey

public String getKey()

User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, and itemShippingAddresses (LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.

Specified by:

getKey in interface BaseAddress

Specified by:

getKey in interface BaseAddressMixin

Specified by:

getKey in interface WithKey

Returns:

key

getCountry

public String getCountry()

Name of the country.

Specified by:

getCountry in interface BaseAddress

Specified by:

getCountry in interface BaseAddressMixin

Returns:

country

getTitle

public String getTitle()

Title of the contact, for example 'Dr.'

Specified by:

getTitle in interface BaseAddress

Specified by:

getTitle in interface BaseAddressMixin

Returns:

title

getSalutation

public String getSalutation()

Salutation of the contact, for example 'Mr.' or 'Ms.'

Specified by:

getSalutation in interface BaseAddress

Specified by:

getSalutation in interface BaseAddressMixin

Returns:

salutation

getFirstName

public String getFirstName()

Given name (first name) of the contact.

Specified by:

getFirstName in interface BaseAddress

Specified by:

getFirstName in interface BaseAddressMixin

Returns:

firstName

getLastName

public String getLastName()

Family name (last name) of the contact.

Specified by:

getLastName in interface BaseAddress

Specified by:

getLastName in interface BaseAddressMixin

Returns:

lastName

getStreetName

public String getStreetName()

Name of the street.

Specified by:

getStreetName in interface BaseAddress

Specified by:

getStreetName in interface BaseAddressMixin

Returns:

streetName

getStreetNumber

public String getStreetNumber()

Street number.

Specified by:

getStreetNumber in interface BaseAddress

Specified by:

getStreetNumber in interface BaseAddressMixin

Returns:

streetNumber

getAdditionalStreetInfo

public String getAdditionalStreetInfo()

Further information on the street address.

Specified by:

getAdditionalStreetInfo in interface BaseAddress

Specified by:

getAdditionalStreetInfo in interface BaseAddressMixin

Returns:

additionalStreetInfo

getPostalCode

public String getPostalCode()

Postal code.

Specified by:

getPostalCode in interface BaseAddress

Specified by:

getPostalCode in interface BaseAddressMixin

Returns:

postalCode

getCity

public String getCity()

Name of the city.

Specified by:

getCity in interface BaseAddress

Specified by:

getCity in interface BaseAddressMixin

Returns:

city

getRegion

public String getRegion()

Name of the region.

Specified by:

getRegion in interface BaseAddress

Specified by:

getRegion in interface BaseAddressMixin

Returns:

region

getState

public String getState()

Name of the state, for example, Colorado.

Specified by:

getState in interface BaseAddress

Specified by:

getState in interface BaseAddressMixin

Returns:

state

getCompany

public String getCompany()

Name of the company.

Specified by:

getCompany in interface BaseAddress

Specified by:

getCompany in interface BaseAddressMixin

Returns:

company

getDepartment

public String getDepartment()

Name of the department.

Specified by:

getDepartment in interface BaseAddress

Specified by:

getDepartment in interface BaseAddressMixin

Returns:

department

getBuilding

public String getBuilding()

Number or name of the building.

Specified by:

getBuilding in interface BaseAddress

Specified by:

getBuilding in interface BaseAddressMixin

Returns:

building

getApartment

public String getApartment()

Number or name of the apartment.

Specified by:

getApartment in interface BaseAddress

Specified by:

getApartment in interface BaseAddressMixin

Returns:

apartment

getPOBox

public String getPOBox()

Post office box number.

Specified by:

getPOBox in interface BaseAddress

Specified by:

getPOBox in interface BaseAddressMixin

Returns:

pOBox

getPhone

public String getPhone()

Phone number of the contact.

Specified by:

getPhone in interface BaseAddress

Specified by:

getPhone in interface BaseAddressMixin

Returns:

phone

getMobile

public String getMobile()

Mobile phone number of the contact.

Specified by:

getMobile in interface BaseAddress

Specified by:

getMobile in interface BaseAddressMixin

Returns:

mobile

getEmail

public String getEmail()

Email address of the contact.

Specified by:

getEmail in interface BaseAddress

Specified by:

getEmail in interface BaseAddressMixin

Returns:

email

getFax

public String getFax()

Fax number of the contact.

Specified by:

getFax in interface BaseAddress

Specified by:

getFax in interface BaseAddressMixin

Returns:

fax

getAdditionalAddressInfo

public String getAdditionalAddressInfo()

Further information on the Address.

Specified by:

getAdditionalAddressInfo in interface BaseAddress

Specified by:

getAdditionalAddressInfo in interface BaseAddressMixin

Returns:

additionalAddressInfo

getExternalId

public String getExternalId()

ID for the contact used in an external system.

Specified by:

getExternalId in interface BaseAddress

Specified by:

getExternalId in interface BaseAddressMixin

Returns:

externalId

setId

public void setId(String id)

Description copied from interface: BaseAddress

Unique identifier of the Address.

It is not recommended to set it manually since the API overwrites this ID when creating an Address for a Customer. Use key instead and omit this field from the request to let the API generate the ID for the Address.

Specified by:

setId in interface BaseAddress

Parameters:

id - value to be set

setKey

public void setKey(String key)

Description copied from interface: BaseAddress

User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, and itemShippingAddresses (LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.

Specified by:

setKey in interface BaseAddress

Parameters:

key - value to be set

setCountry

public void setCountry(String country)

Description copied from interface: BaseAddress

Name of the country.

Specified by:

setCountry in interface BaseAddress

Parameters:

country - value to be set

setTitle

public void setTitle(String title)

Description copied from interface: BaseAddress

Title of the contact, for example 'Dr.'

Specified by:

setTitle in interface BaseAddress

Parameters:

title - value to be set

setSalutation

public void setSalutation(String salutation)

Description copied from interface: BaseAddress

Salutation of the contact, for example 'Mr.' or 'Ms.'

Specified by:

setSalutation in interface BaseAddress

Parameters:

salutation - value to be set

setFirstName

public void setFirstName(String firstName)

Description copied from interface: BaseAddress

Given name (first name) of the contact.

Specified by:

setFirstName in interface BaseAddress

Parameters:

firstName - value to be set

setLastName

public void setLastName(String lastName)

Description copied from interface: BaseAddress

Family name (last name) of the contact.

Specified by:

setLastName in interface BaseAddress

Parameters:

lastName - value to be set

setStreetName

public void setStreetName(String streetName)

Description copied from interface: BaseAddress

Name of the street.

Specified by:

setStreetName in interface BaseAddress

Parameters:

streetName - value to be set

setStreetNumber

public void setStreetNumber(String streetNumber)

Description copied from interface: BaseAddress

Street number.

Specified by:

setStreetNumber in interface BaseAddress

Parameters:

streetNumber - value to be set

setAdditionalStreetInfo

public void setAdditionalStreetInfo(String additionalStreetInfo)

Description copied from interface: BaseAddress

Further information on the street address.

Specified by:

setAdditionalStreetInfo in interface BaseAddress

Parameters:

additionalStreetInfo - value to be set

setPostalCode

public void setPostalCode(String postalCode)

Description copied from interface: BaseAddress

Postal code.

Specified by:

setPostalCode in interface BaseAddress

Parameters:

postalCode - value to be set

setCity

public void setCity(String city)

Description copied from interface: BaseAddress

Name of the city.

Specified by:

setCity in interface BaseAddress

Parameters:

city - value to be set

setRegion

public void setRegion(String region)

Description copied from interface: BaseAddress

Name of the region.

Specified by:

setRegion in interface BaseAddress

Parameters:

region - value to be set

setState

public void setState(String state)

Description copied from interface: BaseAddress

Name of the state, for example, Colorado.

Specified by:

setState in interface BaseAddress

Parameters:

state - value to be set

setCompany

public void setCompany(String company)

Description copied from interface: BaseAddress

Name of the company.

Specified by:

setCompany in interface BaseAddress

Parameters:

company - value to be set

setDepartment

public void setDepartment(String department)

Description copied from interface: BaseAddress

Name of the department.

Specified by:

setDepartment in interface BaseAddress

Parameters:

department - value to be set

setBuilding

public void setBuilding(String building)

Description copied from interface: BaseAddress

Number or name of the building.

Specified by:

setBuilding in interface BaseAddress

Parameters:

building - value to be set

setApartment

public void setApartment(String apartment)

Description copied from interface: BaseAddress

Number or name of the apartment.

Specified by:

setApartment in interface BaseAddress

Parameters:

apartment - value to be set

setPOBox

public void setPOBox(String pOBox)

Description copied from interface: BaseAddress

Post office box number.

Specified by:

setPOBox in interface BaseAddress

Parameters:

pOBox - value to be set

setPhone

public void setPhone(String phone)

Description copied from interface: BaseAddress

Phone number of the contact.

Specified by:

setPhone in interface BaseAddress

Parameters:

phone - value to be set

setMobile

public void setMobile(String mobile)

Description copied from interface: BaseAddress

Mobile phone number of the contact.

Specified by:

setMobile in interface BaseAddress

Parameters:

mobile - value to be set

setEmail

public void setEmail(String email)

Description copied from interface: BaseAddress

Email address of the contact.

Specified by:

setEmail in interface BaseAddress

Parameters:

email - value to be set

setFax

public void setFax(String fax)

Description copied from interface: BaseAddress

Fax number of the contact.

Specified by:

setFax in interface BaseAddress

Parameters:

fax - value to be set

setAdditionalAddressInfo

public void setAdditionalAddressInfo(String additionalAddressInfo)

Description copied from interface: BaseAddress

Further information on the Address.

Specified by:

setAdditionalAddressInfo in interface BaseAddress

Parameters:

additionalAddressInfo - value to be set

setExternalId

public void setExternalId(String externalId)

Description copied from interface: BaseAddress

ID for the contact used in an external system.

Specified by:

setExternalId in interface BaseAddress

Parameters:

externalId - value to be set

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

copyDeep

public BaseAddress copyDeep()

Specified by:

copyDeep in interface BaseAddress