Class Address
java.lang.Object
com.broadleafcommerce.paymenttransaction.domain.Address
- All Implemented Interfaces:
Serializable
The street address for a physical location.
- Author:
- Chad Harchar (charchar)
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAdditionalAttribute
(String name, Object value) Takes in any additional attributes passed in the request not matching any defined properties.protected boolean
boolean
Return any additional attributes passed in the request not matching any defined properties.Primary address information, typically street name and building number.Secondary address information, like apartment, suite, or unit number.Tertiary address information, typically for international addresses.getCity()
The city, town or village of this address.The name of the company at this address.Returns the completed name : Either thefullName
if present or the concatenation of thefirstName
andlastName
.The country for this address.The county of this address.The email address of the individual at this physical address.The first name of the individual at this address.The combined names of the individual at this address.The last name of the individual at this address.Thefax number
for this address.The primaryphone number
for this address.The secondaryphone number
for this address.Postal code or ZIP code for this address.The state, province or region of this address.int
hashCode()
boolean
isActive()
Whether this address is an active address of the owner.boolean
Whether this address is the default address of the owner.void
setActive
(boolean isActive) Whether this address is an active address of the owner.void
setAdditionalAttributes
(Map<String, Object> additionalAttributes) Map holding any additional attributes passed in the request not matching any defined properties.void
setAddressLine1
(String addressLine1) Primary address information, typically street name and building number.void
setAddressLine2
(String addressLine2) Secondary address information, like apartment, suite, or unit number.void
setAddressLine3
(String addressLine3) Tertiary address information, typically for international addresses.void
The city, town or village of this address.void
setCompanyName
(String companyName) The name of the company at this address.void
setCountry
(String country) The country for this address.void
The county of this address.void
setDefault
(boolean isDefault) Whether this address is the default address of the owner.void
setEmailAddress
(String emailAddress) The email address of the individual at this physical address.void
setFirstName
(String firstName) The first name of the individual at this address.void
setFullName
(String fullName) The combined names of the individual at this address.void
setLastName
(String lastName) The last name of the individual at this address.void
setPhoneFax
(Phone phoneFax) Thefax number
for this address.void
setPhonePrimary
(Phone phonePrimary) The primaryphone number
for this address.void
setPhoneSecondary
(Phone phoneSecondary) The secondaryphone number
for this address.void
setPostalCode
(String postalCode) Postal code or ZIP code for this address.void
setStateProvinceRegion
(String stateProvinceRegion) The state, province or region of this address.
-
Constructor Details
-
Address
public Address()
-
-
Method Details
-
addAdditionalAttribute
Takes in any additional attributes passed in the request not matching any defined properties.- Parameters:
name
- Name of the additional attributevalue
- Value of the additional attribute
-
getAdditionalAttributes
Return any additional attributes passed in the request not matching any defined properties.- Returns:
- any additional attributes passed in the request not matching any defined properties.
-
getCompletedName
Returns the completed name : Either thefullName
if present or the concatenation of thefirstName
andlastName
.- Returns:
- the completed name : Either the
fullName
if present or the concatenation of thefirstName
andlastName
.
-
getFirstName
The first name of the individual at this address.- Returns:
- The first name of the individual at this address.
-
getLastName
The last name of the individual at this address.- Returns:
- The last name of the individual at this address.
-
getFullName
The combined names of the individual at this address. It is considered better UX to use a full name field in place of separate first and last name fields.- Returns:
- The combined names of the individual at this address
-
getEmailAddress
The email address of the individual at this physical address.- Returns:
- The email address of the individual at this physical address.
-
getCompanyName
The name of the company at this address.- Returns:
- The name of the company at this address.
-
getAddressLine1
Primary address information, typically street name and building number.- Returns:
- Primary address information, typically street name and building number.
-
getAddressLine2
Secondary address information, like apartment, suite, or unit number.- Returns:
- Secondary address information, like apartment number or suite number.
-
getAddressLine3
Tertiary address information, typically for international addresses.- Returns:
- Tertiary address information, typically for international addresses.
-
getCity
The city, town or village of this address.- Returns:
- The city, town or village of this address.
-
getStateProvinceRegion
The state, province or region of this address.- Returns:
- The state, province or region of this address.
-
getCounty
The county of this address.- Returns:
- The county of this address.
-
getCountry
The country for this address.- Returns:
- The country for this address.
-
getPostalCode
Postal code or ZIP code for this address.- Returns:
- Postal code or ZIP code for this address.
-
getPhonePrimary
The primaryphone number
for this address.- Returns:
- The primary
phone number
for this address.
-
getPhoneSecondary
The secondaryphone number
for this address.- Returns:
- The secondary
phone number
for this address.
-
getPhoneFax
Thefax number
for this address.- Returns:
- The
fax number
for this address.
-
isDefault
public boolean isDefault()Whether this address is the default address of the owner.- Returns:
- Whether this address is the default address of the owner.
-
isActive
public boolean isActive()Whether this address is an active address of the owner.- Returns:
- Whether this address is an active address of the owner.
-
setFirstName
The first name of the individual at this address.- Parameters:
firstName
- The first name of the individual at this address.
-
setLastName
The last name of the individual at this address.- Parameters:
lastName
- The last name of the individual at this address.
-
setFullName
The combined names of the individual at this address. It is considered better UX to use a full name field in place of separate first and last name fields.- Parameters:
fullName
- The combined names of the individual at this address
-
setEmailAddress
The email address of the individual at this physical address.- Parameters:
emailAddress
- The email address of the individual at this physical address.
-
setCompanyName
The name of the company at this address.- Parameters:
companyName
- The name of the company at this address.
-
setAddressLine1
Primary address information, typically street name and building number.- Parameters:
addressLine1
- Primary address information, typically street name and building number.
-
setAddressLine2
Secondary address information, like apartment, suite, or unit number.- Parameters:
addressLine2
- Secondary address information, like apartment number or suite number.
-
setAddressLine3
Tertiary address information, typically for international addresses.- Parameters:
addressLine3
- Tertiary address information, typically for international addresses.
-
setCity
The city, town or village of this address.- Parameters:
city
- The city, town or village of this address.
-
setStateProvinceRegion
The state, province or region of this address.- Parameters:
stateProvinceRegion
- The state, province or region of this address.
-
setCounty
The county of this address.- Parameters:
county
- The county of this address.
-
setCountry
The country for this address.- Parameters:
country
- The country for this address.
-
setPostalCode
Postal code or ZIP code for this address.- Parameters:
postalCode
- Postal code or ZIP code for this address.
-
setPhonePrimary
The primaryphone number
for this address.- Parameters:
phonePrimary
- The primaryphone number
for this address.
-
setPhoneSecondary
The secondaryphone number
for this address.- Parameters:
phoneSecondary
- The secondaryphone number
for this address.
-
setPhoneFax
Thefax number
for this address.- Parameters:
phoneFax
- Thefax number
for this address.
-
setDefault
public void setDefault(boolean isDefault) Whether this address is the default address of the owner.- Parameters:
isDefault
- Whether this address is the default address of the owner.
-
setActive
public void setActive(boolean isActive) Whether this address is an active address of the owner.- Parameters:
isActive
- Whether this address is an active address of the owner.
-
setAdditionalAttributes
Map holding any additional attributes passed in the request not matching any defined properties. -
equals
-
canEqual
-
hashCode
public int hashCode()
-