Portable postal address, used as a nested property when building organisation, user and shopping cart addresses. Serialised via XStream under the "address" alias when addresses are persisted as XML, and its properties are exported to server-side JavaScript so controllers and templates can build or edit an address directly. It also carries who last modified it and when, for auditing purposes.

Group: Addresses

Implements: IReadableAddress


Properties

PropertyReturnsDescription
addressLine1StringThe first line of the street address, for example a street number and name.
addressLine2StringThe second line of the street address, for example a unit or building name. Usually optional.
addressStateStringThe state or province of this address.
cityStringThe city or town of this address.
countryStringThe country of this address.
modifiedByProfileThe profile that last modified this address.
modifiedDateDateThe date this address was last modified.
postcodeStringThe postal or zip code of this address.

Methods

getAddressLine1() · setAddressLine1(String addressLine1) · getAddressLine2() · setAddressLine2(String addressLine2) · getCity() · setCity(String city) · getAddressState() · setAddressState(String addressState) · getCountry() · setCountry(String country) · getPostcode() · setPostcode(String postcode) · getModifiedBy() · setModifiedBy(Profile modifiedBy) · getModifiedDate() · setModifiedDate(Date modifiedDate)

getAddressLine1()

Returns: String

The first line of the street address, for example a street number and name.

setAddressLine1(String addressLine1)

Returns: void

Sets the first line of the street address.

ParameterDescription
addressLine1the first address line

getAddressLine2()

Returns: String

The second line of the street address, for example a unit or building name. Usually optional.

setAddressLine2(String addressLine2)

Returns: void

Sets the second line of the street address.

ParameterDescription
addressLine2the second address line

getCity()

Returns: String

The city or town of this address.

setCity(String city)

Returns: void

Sets the city or town of this address.

ParameterDescription
citythe city name

getAddressState()

Returns: String

The state or province of this address.

setAddressState(String addressState)

Returns: void

Sets the state or province of this address.

ParameterDescription
addressStatethe state or province

getCountry()

Returns: String

The country of this address.

setCountry(String country)

Returns: void

Sets the country of this address.

ParameterDescription
countrythe country name

getPostcode()

Returns: String

The postal or zip code of this address.

setPostcode(String postcode)

Returns: void

Sets the postal or zip code of this address.

ParameterDescription
postcodethe postcode

getModifiedBy()

Returns: Profile

The profile that last modified this address.

setModifiedBy(Profile modifiedBy)

Returns: void

Sets the profile that last modified this address.

ParameterDescription
modifiedBythe profile that last modified this address

getModifiedDate()

Returns: Date

The date this address was last modified.

setModifiedDate(Date modifiedDate)

Returns: void

Sets the date this address was last modified.

ParameterDescription
modifiedDatethe last-modified date
To get full access to the Kademi Hub existing customers can login here, or new customers can register here.