Package com.broadleafcommerce.customer.domain

Class AccountAddress

java.lang.Object
com.broadleafcommerce.customer.domain.AccountAddress
All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware, com.broadleafcommerce.data.tracking.core.policy.Owned, Serializable
public class AccountAddress extends Object implements com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable, com.broadleafcommerce.data.tracking.core.policy.Owned
A physical address related to the Account. In a B2B context, this may represent the "Ship To" or "Bill To" address for the business/department.
Author:
Chris Kittrell (ckittrell)
See Also:

  • Constructor Details

    • AccountAddress

      public AccountAddress()

  • Method Details

    • addAdditionalAttribute

      public void addAdditionalAttribute(String name, Object value)
      Takes in any additional attributes passed in the request not matching any defined properties.
      Parameters:
      name - Name of the additional attribute
      value - Value of the additional attribute

    • getAdditionalAttributes

      public Map<String,Object> 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.

    • getOwnerIdentifier

      public String getOwnerIdentifier()
      Specified by:
      getOwnerIdentifier in interface com.broadleafcommerce.data.tracking.core.policy.Owned

    • getId

      public String getId()
      The context ID of the relationship.
      Returns:
      the context ID of the relationship

    • getName

      public String getName()
      The user-provided name of the address.
      Returns:
      the user-provided name of the address

    • getType

      public String getType()
      The type of address for this account. For example, in a B2B context, this type may be DefaultB2BAccountAddressTypes.SHIP_TO or DefaultB2BAccountAddressTypes.BILL_TO
      Returns:
      the type of address for this account
      See Also:

    • isDefault

      public boolean isDefault()
      Specifies whether or not this is the default for this type of address.
      Returns:
      whether or not this is the default for this type of address

    • getAccountRef

      public AccountRef getAccountRef()
      The account in the relationship.
      Returns:
      the account in the relationship

    • getFirstName

      public String getFirstName()
      The first name of the individual at this address.
      Returns:
      The first name of the individual at this address.

    • getLastName

      public String getLastName()
      The last name of the individual at this address.
      Returns:
      The last name of the individual at this address.

    • getFullName

      public String 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

      public String getEmailAddress()
      The email address of the individual at this physical address.
      Returns:
      The email address of the individual at this physical address.

    • getCompanyName

      public String getCompanyName()
      The name of the company at this address.
      Returns:
      The name of the company at this address.

    • getAddressLine1

      public String getAddressLine1()
      Primary address information, typically street name and building number.
      Returns:
      Primary address information, typically street name and building number.

    • getAddressLine2

      public String getAddressLine2()
      Secondary address information, like apartment, suite, or unit number.
      Returns:
      Secondary address information, like apartment number or suite number.

    • getAddressLine3

      public String getAddressLine3()
      Tertiary address information, typically for international addresses.
      Returns:
      Tertiary address information, typically for international addresses.

    • getCity

      public String getCity()
      The city, town or village of this address.
      Returns:
      The city, town or village of this address.

    • getCounty

      public String getCounty()
      The county of this address.
      Returns:
      The county of this address.

    • getStateProvinceRegion

      public String getStateProvinceRegion()
      The state, province or region of this address.
      Returns:
      The state, province or region of this address.

    • getCountry

      public String getCountry()
      The country for this address.
      Returns:
      The country for this address.

    • getPostalCode

      public String getPostalCode()
      Postal code or ZIP code for this address.
      Returns:
      Postal code or ZIP code for this address.

    • getPhonePrimary

      public Phone getPhonePrimary()
      The primary phone number for this address.
      Returns:
      The primary phone number for this address.

    • getPhoneSecondary

      public Phone getPhoneSecondary()
      The secondary phone number for this address.
      Returns:
      The secondary phone number for this address.

    • getPhoneFax

      public Phone getPhoneFax()
      The fax number for this address.
      Returns:
      The fax number for this address.

    • 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.

    • getVisibleToChildren

      public String getVisibleToChildren()
      Whether this address is visible to Children.
      Returns:
      Whether this address is visible to Children.
      See Also:

    • getContextState

      public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
      Returns:
      a subset of Tracking information to expose the context state for this object

    • setId

      public void setId(String id)
      The context ID of the relationship.
      Parameters:
      id - the context ID of the relationship

    • setName

      public void setName(String name)
      The user-provided name of the address.
      Parameters:
      name - the user-provided name of the address

    • setType

      public void setType(String type)
      The type of address for this account. For example, in a B2B context, this type may be DefaultB2BAccountAddressTypes.SHIP_TO or DefaultB2BAccountAddressTypes.BILL_TO
      Parameters:
      type - the type of address for this account
      See Also:

    • setDefault

      public void setDefault(boolean isDefault)
      Specifies whether or not this is the default for this type of address.
      Parameters:
      isDefault - whether or not this is the default for this type of address

    • setAccountRef

      public void setAccountRef(AccountRef accountRef)
      The account in the relationship.
      Parameters:
      account - the account in the relationship

    • setFirstName

      public void setFirstName(String firstName)
      The first name of the individual at this address.
      Parameters:
      firstName - The first name of the individual at this address.

    • setLastName

      public void setLastName(String lastName)
      The last name of the individual at this address.
      Parameters:
      lastName - The last name of the individual at this address.

    • setFullName

      public void setFullName(String fullName)
      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

      public void setEmailAddress(String emailAddress)
      The email address of the individual at this physical address.
      Parameters:
      emailAddress - The email address of the individual at this physical address.

    • setCompanyName

      public void setCompanyName(String companyName)
      The name of the company at this address.
      Parameters:
      companyName - The name of the company at this address.

    • setAddressLine1

      public void setAddressLine1(String addressLine1)
      Primary address information, typically street name and building number.
      Parameters:
      addressLine1 - Primary address information, typically street name and building number.

    • setAddressLine2

      public void setAddressLine2(String addressLine2)
      Secondary address information, like apartment, suite, or unit number.
      Parameters:
      addressLine2 - Secondary address information, like apartment number or suite number.

    • setAddressLine3

      public void setAddressLine3(String addressLine3)
      Tertiary address information, typically for international addresses.
      Parameters:
      addressLine3 - Tertiary address information, typically for international addresses.

    • setCity

      public void setCity(String city)
      The city, town or village of this address.
      Parameters:
      city - The city, town or village of this address.

    • setCounty

      public void setCounty(String county)
      The county of this address.
      Parameters:
      county - The county of this address.

    • setStateProvinceRegion

      public void setStateProvinceRegion(String stateProvinceRegion)
      The state, province or region of this address.
      Parameters:
      stateProvinceRegion - The state, province or region of this address.

    • setCountry

      public void setCountry(String country)
      The country for this address.
      Parameters:
      country - The country for this address.

    • setPostalCode

      public void setPostalCode(String postalCode)
      Postal code or ZIP code for this address.
      Parameters:
      postalCode - Postal code or ZIP code for this address.

    • setPhonePrimary

      public void setPhonePrimary(Phone phonePrimary)
      The primary phone number for this address.
      Parameters:
      phonePrimary - The primary phone number for this address.

    • setPhoneSecondary

      public void setPhoneSecondary(Phone phoneSecondary)
      The secondary phone number for this address.
      Parameters:
      phoneSecondary - The secondary phone number for this address.

    • setPhoneFax

      public void setPhoneFax(Phone phoneFax)
      The fax number for this address.
      Parameters:
      phoneFax - The fax number for this address.

    • 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.

    • setVisibleToChildren

      public void setVisibleToChildren(String visibleToChildren)
      Whether this address is visible to Children.
      Parameters:
      visibleToChildren - Whether this address is visible to Children.
      See Also:

    • setAdditionalAttributes

      public void setAdditionalAttributes(Map<String,Object> additionalAttributes)
      Map holding any additional attributes passed in the request not matching any defined properties.

    • setContextState

      public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
      Parameters:
      contextState - a subset of Tracking information to expose the context state for this object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object