Class GeographicAddress

java.lang.Object
de.hybris.platform.b2ctelcotmfresources.v4.dto.GeographicAddress

public class GeographicAddress extends Object
A geographic address is a structured textual way of describing how to find a Property in an urban area (country properties are often defined differently)
  • Constructor Details

    • GeographicAddress

      public GeographicAddress()
  • Method Details

    • id

      public GeographicAddress id(String id)
    • getId

      public String getId()
      Unique identifier of the address
      Returns:
      id
    • setId

      public void setId(String id)
    • href

      public GeographicAddress href(String href)
    • getHref

      public String getHref()
      An URI used to access to the address resource
      Returns:
      href
    • setHref

      public void setHref(String href)
    • role

      public GeographicAddress role(String role)
    • getRole

      public String getRole()
      Get role
      Returns:
      role
    • setRole

      public void setRole(String role)
    • 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)
    • streetNrSuffix

      public GeographicAddress streetNrSuffix(String streetNrSuffix)
    • getStreetNrSuffix

      public String getStreetNrSuffix()
      The first street number suffix
      Returns:
      streetNrSuffix
    • setStreetNrSuffix

      public void setStreetNrSuffix(String streetNrSuffix)
    • 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)
    • 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)
    • 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)
    • streetSuffix

      public GeographicAddress streetSuffix(String streetSuffix)
    • getStreetSuffix

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

      public void setStreetSuffix(String streetSuffix)
    • 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 known as zipcode)
      Returns:
      postcode
    • setPostcode

      public void setPostcode(String postcode)
    • 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
      Returns:
      locality
    • setLocality

      public void setLocality(String locality)
    • city

      public GeographicAddress city(String city)
    • getCity

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

      public void setCity(String city)
    • stateOfProvince

      public GeographicAddress stateOfProvince(String stateOfProvince)
    • getStateOfProvince

      public String getStateOfProvince()
      The State or Province that the address is in
      Returns:
      stateOfProvince
    • setStateOfProvince

      public void setStateOfProvince(String stateOfProvince)
    • country

      public GeographicAddress country(String country)
    • getCountry

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

      public void setCountry(String country)
    • atType

      public GeographicAddress atType(String atType)
    • getAtType

      public String getAtType()
      Indicates the type of the resource. Here can be 'UrbanPropertyAddress', ‘FormattedAddress’, ‘JapanesePropertyAddress’ , ‘AustralianPropertyAddress’, etc…
      Returns:
      atType
    • setAtType

      public void setAtType(String atType)
    • atSchemaLocation

      public GeographicAddress atSchemaLocation(String atSchemaLocation)
    • getAtSchemaLocation

      public String getAtSchemaLocation()
      A Link to the schema describing this REST Resource. The resource described 'UrbanPropertyAddress' but a schema could be used for other property address description.
      Returns:
      atSchemaLocation
    • setAtSchemaLocation

      public void setAtSchemaLocation(String atSchemaLocation)
    • 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