Class AddressDraftImpl
- All Implemented Interfaces:
AddressDraft
,BaseAddress
,BaseAddressMixin
,CustomizableDraft<AddressDraft>
,WithKey
,io.vrap.rmf.base.client.Draft<AddressDraft>
,io.vrap.rmf.base.client.ModelBase
Address type to be used on write methods. Optionally, use the custom
field in addition to the fields of a BaseAddress.
-
Nested Class Summary
Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase
io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Further information on the Address.Further information on the street address.Number or name of the apartment.Number or name of the building.getCity()
Name of the city.Name of the company.Name of the country.Custom Fields defined for the Address.Name of the department.getEmail()
Email address of the contact.ID for the contact used in an external system.getFax()
Fax number of the contact.Given name (first name) of the contact.getId()
Unique identifier of the Address.getKey()
User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, anditemShippingAddresses
(LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.Family name (last name) of the contact.Mobile phone number of the contact.getPhone()
Phone number of the contact.getPOBox()
Post office box number.Postal code.Name of the region.Salutation of the contact, for example 'Mr.' or 'Ms.'getState()
Name of the state, for example, Colorado.Name of the street.Street number.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
Name of the city.void
setCompany
(String company) Name of the company.void
setCountry
(String country) Name of the country.void
setCustom
(CustomFieldsDraft custom) Custom Fields defined for the Address.void
setDepartment
(String department) Name of the department.void
Email address of the contact.void
setExternalId
(String externalId) ID for the contact used in an external system.void
Fax number of the contact.void
setFirstName
(String firstName) Given name (first name) of the contact.void
Unique identifier of the Address.void
User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, anditemShippingAddresses
(LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.void
setLastName
(String lastName) Family name (last name) of the contact.void
Mobile phone number of the contact.void
Phone number of the contact.void
Post office box number.void
setPostalCode
(String postalCode) Postal code.void
Name of the region.void
setSalutation
(String salutation) Salutation of the contact, for example 'Mr.' or 'Ms.'void
Name of the state, for example, Colorado.void
setStreetName
(String streetName) Name of the street.void
setStreetNumber
(String streetNumber) Street number.void
Title of the contact, for example 'Dr.'Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.commercetools.api.models.common.AddressDraft
withAddressDraft
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 com.commercetools.api.models.CustomizableDraft
unwrapCustomizableDraft
Methods inherited from interface io.vrap.rmf.base.client.ModelBase
reflectionString, reflectionString
-
Constructor Details
-
AddressDraftImpl
public AddressDraftImpl()create empty instance
-
-
Method Details
-
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 interfaceBaseAddress
- Returns:
- id
-
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 interfaceBaseAddress
- Specified by:
getKey
in interfaceBaseAddressMixin
- Specified by:
getKey
in interfaceWithKey
- Returns:
- key
-
getCountry
Name of the country.
- Specified by:
getCountry
in interfaceBaseAddress
- Specified by:
getCountry
in interfaceBaseAddressMixin
- Returns:
- country
-
getTitle
Title of the contact, for example 'Dr.'
- Specified by:
getTitle
in interfaceBaseAddress
- Specified by:
getTitle
in interfaceBaseAddressMixin
- Returns:
- title
-
getSalutation
Salutation of the contact, for example 'Mr.' or 'Ms.'
- Specified by:
getSalutation
in interfaceBaseAddress
- Specified by:
getSalutation
in interfaceBaseAddressMixin
- Returns:
- salutation
-
getFirstName
Given name (first name) of the contact.
- Specified by:
getFirstName
in interfaceBaseAddress
- Specified by:
getFirstName
in interfaceBaseAddressMixin
- Returns:
- firstName
-
getLastName
Family name (last name) of the contact.
- Specified by:
getLastName
in interfaceBaseAddress
- Specified by:
getLastName
in interfaceBaseAddressMixin
- Returns:
- lastName
-
getStreetName
Name of the street.
- Specified by:
getStreetName
in interfaceBaseAddress
- Specified by:
getStreetName
in interfaceBaseAddressMixin
- Returns:
- streetName
-
getStreetNumber
Street number.
- Specified by:
getStreetNumber
in interfaceBaseAddress
- Specified by:
getStreetNumber
in interfaceBaseAddressMixin
- Returns:
- streetNumber
-
getAdditionalStreetInfo
Further information on the street address.
- Specified by:
getAdditionalStreetInfo
in interfaceBaseAddress
- Specified by:
getAdditionalStreetInfo
in interfaceBaseAddressMixin
- Returns:
- additionalStreetInfo
-
getPostalCode
Postal code.
- Specified by:
getPostalCode
in interfaceBaseAddress
- Specified by:
getPostalCode
in interfaceBaseAddressMixin
- Returns:
- postalCode
-
getCity
Name of the city.
- Specified by:
getCity
in interfaceBaseAddress
- Specified by:
getCity
in interfaceBaseAddressMixin
- Returns:
- city
-
getRegion
Name of the region.
- Specified by:
getRegion
in interfaceBaseAddress
- Specified by:
getRegion
in interfaceBaseAddressMixin
- Returns:
- region
-
getState
Name of the state, for example, Colorado.
- Specified by:
getState
in interfaceBaseAddress
- Specified by:
getState
in interfaceBaseAddressMixin
- Returns:
- state
-
getCompany
Name of the company.
- Specified by:
getCompany
in interfaceBaseAddress
- Specified by:
getCompany
in interfaceBaseAddressMixin
- Returns:
- company
-
getDepartment
Name of the department.
- Specified by:
getDepartment
in interfaceBaseAddress
- Specified by:
getDepartment
in interfaceBaseAddressMixin
- Returns:
- department
-
getBuilding
Number or name of the building.
- Specified by:
getBuilding
in interfaceBaseAddress
- Specified by:
getBuilding
in interfaceBaseAddressMixin
- Returns:
- building
-
getApartment
Number or name of the apartment.
- Specified by:
getApartment
in interfaceBaseAddress
- Specified by:
getApartment
in interfaceBaseAddressMixin
- Returns:
- apartment
-
getPOBox
Post office box number.
- Specified by:
getPOBox
in interfaceBaseAddress
- Specified by:
getPOBox
in interfaceBaseAddressMixin
- Returns:
- pOBox
-
getPhone
Phone number of the contact.
- Specified by:
getPhone
in interfaceBaseAddress
- Specified by:
getPhone
in interfaceBaseAddressMixin
- Returns:
- phone
-
getMobile
Mobile phone number of the contact.
- Specified by:
getMobile
in interfaceBaseAddress
- Specified by:
getMobile
in interfaceBaseAddressMixin
- Returns:
- mobile
-
getEmail
Email address of the contact.
- Specified by:
getEmail
in interfaceBaseAddress
- Specified by:
getEmail
in interfaceBaseAddressMixin
- Returns:
-
getFax
Fax number of the contact.
- Specified by:
getFax
in interfaceBaseAddress
- Specified by:
getFax
in interfaceBaseAddressMixin
- Returns:
- fax
-
getAdditionalAddressInfo
Further information on the Address.
- Specified by:
getAdditionalAddressInfo
in interfaceBaseAddress
- Specified by:
getAdditionalAddressInfo
in interfaceBaseAddressMixin
- Returns:
- additionalAddressInfo
-
getExternalId
ID for the contact used in an external system.
- Specified by:
getExternalId
in interfaceBaseAddress
- Specified by:
getExternalId
in interfaceBaseAddressMixin
- Returns:
- externalId
-
getCustom
Custom Fields defined for the Address.
- Specified by:
getCustom
in interfaceAddressDraft
- Specified by:
getCustom
in interfaceCustomizableDraft<AddressDraft>
- Returns:
- custom
-
setId
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 interfaceBaseAddress
- Parameters:
id
- value to be set
-
setKey
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 interfaceBaseAddress
- Parameters:
key
- value to be set
-
setCountry
Description copied from interface:BaseAddress
Name of the country.
- Specified by:
setCountry
in interfaceBaseAddress
- Parameters:
country
- value to be set
-
setTitle
Description copied from interface:BaseAddress
Title of the contact, for example 'Dr.'
- Specified by:
setTitle
in interfaceBaseAddress
- Parameters:
title
- value to be set
-
setSalutation
Description copied from interface:BaseAddress
Salutation of the contact, for example 'Mr.' or 'Ms.'
- Specified by:
setSalutation
in interfaceBaseAddress
- Parameters:
salutation
- value to be set
-
setFirstName
Description copied from interface:BaseAddress
Given name (first name) of the contact.
- Specified by:
setFirstName
in interfaceBaseAddress
- Parameters:
firstName
- value to be set
-
setLastName
Description copied from interface:BaseAddress
Family name (last name) of the contact.
- Specified by:
setLastName
in interfaceBaseAddress
- Parameters:
lastName
- value to be set
-
setStreetName
Description copied from interface:BaseAddress
Name of the street.
- Specified by:
setStreetName
in interfaceBaseAddress
- Parameters:
streetName
- value to be set
-
setStreetNumber
Description copied from interface:BaseAddress
Street number.
- Specified by:
setStreetNumber
in interfaceBaseAddress
- Parameters:
streetNumber
- value to be set
-
setAdditionalStreetInfo
Description copied from interface:BaseAddress
Further information on the street address.
- Specified by:
setAdditionalStreetInfo
in interfaceBaseAddress
- Parameters:
additionalStreetInfo
- value to be set
-
setPostalCode
Description copied from interface:BaseAddress
Postal code.
- Specified by:
setPostalCode
in interfaceBaseAddress
- Parameters:
postalCode
- value to be set
-
setCity
Description copied from interface:BaseAddress
Name of the city.
- Specified by:
setCity
in interfaceBaseAddress
- Parameters:
city
- value to be set
-
setRegion
Description copied from interface:BaseAddress
Name of the region.
- Specified by:
setRegion
in interfaceBaseAddress
- Parameters:
region
- value to be set
-
setState
Description copied from interface:BaseAddress
Name of the state, for example, Colorado.
- Specified by:
setState
in interfaceBaseAddress
- Parameters:
state
- value to be set
-
setCompany
Description copied from interface:BaseAddress
Name of the company.
- Specified by:
setCompany
in interfaceBaseAddress
- Parameters:
company
- value to be set
-
setDepartment
Description copied from interface:BaseAddress
Name of the department.
- Specified by:
setDepartment
in interfaceBaseAddress
- Parameters:
department
- value to be set
-
setBuilding
Description copied from interface:BaseAddress
Number or name of the building.
- Specified by:
setBuilding
in interfaceBaseAddress
- Parameters:
building
- value to be set
-
setApartment
Description copied from interface:BaseAddress
Number or name of the apartment.
- Specified by:
setApartment
in interfaceBaseAddress
- Parameters:
apartment
- value to be set
-
setPOBox
Description copied from interface:BaseAddress
Post office box number.
- Specified by:
setPOBox
in interfaceBaseAddress
- Parameters:
pOBox
- value to be set
-
setPhone
Description copied from interface:BaseAddress
Phone number of the contact.
- Specified by:
setPhone
in interfaceBaseAddress
- Parameters:
phone
- value to be set
-
setMobile
Description copied from interface:BaseAddress
Mobile phone number of the contact.
- Specified by:
setMobile
in interfaceBaseAddress
- Parameters:
mobile
- value to be set
-
setEmail
Description copied from interface:BaseAddress
Email address of the contact.
- Specified by:
setEmail
in interfaceBaseAddress
- Parameters:
email
- value to be set
-
setFax
Description copied from interface:BaseAddress
Fax number of the contact.
- Specified by:
setFax
in interfaceBaseAddress
- Parameters:
fax
- value to be set
-
setAdditionalAddressInfo
Description copied from interface:BaseAddress
Further information on the Address.
- Specified by:
setAdditionalAddressInfo
in interfaceBaseAddress
- Parameters:
additionalAddressInfo
- value to be set
-
setExternalId
Description copied from interface:BaseAddress
ID for the contact used in an external system.
- Specified by:
setExternalId
in interfaceBaseAddress
- Parameters:
externalId
- value to be set
-
setCustom
Description copied from interface:AddressDraft
Custom Fields defined for the Address.
- Specified by:
setCustom
in interfaceAddressDraft
- Specified by:
setCustom
in interfaceCustomizableDraft<AddressDraft>
- Parameters:
custom
- value to be set
-
equals
-
hashCode
-