Package de.hybris.platform.b2ctelcotmfwebservices.v3.dto

Class GeographicAddress

java.lang.Object
de.hybris.platform.b2ctelcotmfwebservices.v3.dto.GeographicAddress
public class GeographicAddress extends Object
Structured textual way of describing how to find a Property in an urban area (country properties are often defined differently). Note : Address corresponds to SID UrbanPropertyAddress

  • Constructor Details

    • GeographicAddress

      public GeographicAddress()

  • Method Details

    • id

      public GeographicAddress id(String id)

    • getId

      public String getId()
      Unique identifier of the place
      Returns:
      id

    • setId

      public void setId(String id)

    • href

      public GeographicAddress href(String href)

    • getHref

      public String getHref()
      Unique reference of the place
      Returns:
      href

    • setHref

      public void setHref(String href)

    • city

      public GeographicAddress city(String city)

    • getCity

      public String getCity()
      City that the address is in
      Returns:
      city

    • setCity

      public void setCity(String city)

    • country

      public GeographicAddress country(String country)

    • getCountry

      public String getCountry()
      Country that the address is in
      Returns:
      country

    • setCountry

      public void setCountry(String country)

    • locality

      public GeographicAddress locality(String locality)

    • getLocality

      public String getLocality()
      An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]
      Returns:
      locality

    • setLocality

      public void setLocality(String locality)

    • name

      public GeographicAddress name(String name)

    • getName

      public String getName()
      A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]
      Returns:
      name

    • setName

      public void setName(String name)

    • postcode

      public GeographicAddress postcode(String postcode)

    • getPostcode

      public String getPostcode()
      descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)
      Returns:
      postcode

    • setPostcode

      public void setPostcode(String postcode)

    • stateOrProvince

      public GeographicAddress stateOrProvince(String stateOrProvince)

    • getStateOrProvince

      public String getStateOrProvince()
      the State or Province that the address is in
      Returns:
      stateOrProvince

    • setStateOrProvince

      public void setStateOrProvince(String stateOrProvince)

    • streetName

      public GeographicAddress streetName(String streetName)

    • getStreetName

      public String getStreetName()
      Name of the street or other street type
      Returns:
      streetName

    • setStreetName

      public void setStreetName(String streetName)

    • streetNr

      public GeographicAddress streetNr(String streetNr)

    • getStreetNr

      public String getStreetNr()
      Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses
      Returns:
      streetNr

    • setStreetNr

      public void setStreetNr(String streetNr)

    • streetNrLast

      public GeographicAddress streetNrLast(String streetNrLast)

    • getStreetNrLast

      public String getStreetNrLast()
      Last number in a range of street numbers allocated to a property
      Returns:
      streetNrLast

    • setStreetNrLast

      public void setStreetNrLast(String streetNrLast)

    • streetNrLastSuffix

      public GeographicAddress streetNrLastSuffix(String streetNrLastSuffix)

    • getStreetNrLastSuffix

      public String getStreetNrLastSuffix()
      Last street number suffix for a ranged address
      Returns:
      streetNrLastSuffix

    • setStreetNrLastSuffix

      public void setStreetNrLastSuffix(String streetNrLastSuffix)

    • streetNrSuffix

      public GeographicAddress streetNrSuffix(String streetNrSuffix)

    • getStreetNrSuffix

      public String getStreetNrSuffix()
      the first street number suffix
      Returns:
      streetNrSuffix

    • setStreetNrSuffix

      public void setStreetNrSuffix(String streetNrSuffix)

    • streetSuffix

      public GeographicAddress streetSuffix(String streetSuffix)

    • getStreetSuffix

      public String getStreetSuffix()
      A modifier denoting a relative direction
      Returns:
      streetSuffix

    • setStreetSuffix

      public void setStreetSuffix(String streetSuffix)

    • streetType

      public GeographicAddress streetType(String streetType)

    • getStreetType

      public String getStreetType()
      alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf
      Returns:
      streetType

    • setStreetType

      public void setStreetType(String streetType)

    • phone

      public GeographicAddress phone(String phone)

    • getPhone

      public String getPhone()
      landline phone number
      Returns:
      phone

    • setPhone

      public void setPhone(String phone)

    • cellphone

      public GeographicAddress cellphone(String phone)

    • getCellphone

      public String getCellphone()
      mobile phone number
      Returns:
      cellphone

    • setCellphone

      public void setCellphone(String cellphone)

    • countryName

      public GeographicAddress countryName(String countryName)

    • getCountryName

      public String getCountryName()
      country name
      Returns:
      countryName

    • setCountryName

      public void setCountryName(String countryName)

    • geographicSubAddress

      public GeographicAddress geographicSubAddress(List<GeographicSubAddress> geographicSubAddress)

    • addGeographicSubAddressItem

      public GeographicAddress addGeographicSubAddressItem(GeographicSubAddress geographicSubAddressItem)

    • getGeographicSubAddress

      @Valid public @Valid List<GeographicSubAddress> getGeographicSubAddress()
      Get geographicSubAddress
      Returns:
      geographicSubAddress

    • setGeographicSubAddress

      public void setGeographicSubAddress(List<GeographicSubAddress> geographicSubAddress)

    • relatedParty

      public GeographicAddress relatedParty(List<RelatedPartyRef> relatedParty)

    • addRelatedPartyItem

      public GeographicAddress addRelatedPartyItem(RelatedPartyRef relatedPartyItem)

    • getRelatedParty

      @Valid public @Valid List<RelatedPartyRef> getRelatedParty()
      Party role references that the current address is associated with
      Returns:
      relatedParty

    • setRelatedParty

      public void setRelatedParty(List<RelatedPartyRef> relatedParty)

    • atBaseType

      public GeographicAddress atBaseType(String atBaseType)

    • getAtBaseType

      public String getAtBaseType()
      When sub-classing, this defines the super-class
      Returns:
      atBaseType

    • setAtBaseType

      public void setAtBaseType(String atBaseType)

    • atSchemaLocation

      public GeographicAddress atSchemaLocation(String atSchemaLocation)

    • getAtSchemaLocation

      public String getAtSchemaLocation()
      A URI to a JSON-Schema file that defines additional attributes and relationships
      Returns:
      atSchemaLocation

    • setAtSchemaLocation

      public void setAtSchemaLocation(String atSchemaLocation)

    • atType

      public GeographicAddress atType(String atType)

    • getAtType

      public String getAtType()
      When sub-classing, this defines the sub-class entity name
      Returns:
      atType

    • setAtType

      public void setAtType(String atType)

    • isShippingAddress

      public GeographicAddress isShippingAddress(Boolean isShippingAddress)

    • isIsShippingAddress

      public Boolean isIsShippingAddress()
      Flag that specifies if the geographic address is a shipping address.
      Returns:
      isShippingAddress

    • setIsShippingAddress

      public void setIsShippingAddress(Boolean isShippingAddress)

    • isBillingAddress

      public GeographicAddress isBillingAddress(Boolean isBillingAddress)

    • isIsBillingAddress

      public Boolean isIsBillingAddress()
      Flag that specifies if the geographic address is a billing address.
      Returns:
      isBillingAddress

    • setIsBillingAddress

      public void setIsBillingAddress(Boolean isBillingAddress)

    • isContactAddress

      public GeographicAddress isContactAddress(Boolean isContactAddress)

    • isIsContactAddress

      public Boolean isIsContactAddress()
      Flag that specifies if the geographic address is a contact address.
      Returns:
      isContactAddress

    • setIsContactAddress

      public void setIsContactAddress(Boolean isContactAddress)

    • isUnloadingAddress

      public GeographicAddress isUnloadingAddress(Boolean isUnloadingAddress)

    • isIsUnloadingAddress

      public Boolean isIsUnloadingAddress()
      Flag that specifies if the geographic address is an unloading address.
      Returns:
      isUnloadingAddress

    • setIsUnloadingAddress

      public void setIsUnloadingAddress(Boolean isUnloadingAddress)

    • isInstallationAddress

      public GeographicAddress isInstallationAddress(Boolean isInstallationAddress)

    • isIsInstallationAddress

      public Boolean isIsInstallationAddress()
      Flag that specifies if the geographic address is an installation address.
      Returns:
      isInstallationAddress

    • setIsInstallationAddress

      public void setIsInstallationAddress(Boolean isInstallationAddress)

    • 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