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
| Property | Returns | Description |
|---|---|---|
| addressLine1 | String | The first line of the street address, for example a street number and name. |
| addressLine2 | String | The second line of the street address, for example a unit or building name. Usually optional. |
| addressState | String | The state or province of this address. |
| city | String | The city or town of this address. |
| country | String | The country of this address. |
| modifiedBy | Profile | The profile that last modified this address. |
| modifiedDate | Date | The date this address was last modified. |
| postcode | String | The 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.
| Parameter | Description |
|---|---|
addressLine1 | the 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.
| Parameter | Description |
|---|---|
addressLine2 | the 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.
| Parameter | Description |
|---|---|
city | the 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.
| Parameter | Description |
|---|---|
addressState | the state or province |
getCountry()
Returns: String
The country of this address.
setCountry(String country)
Returns: void
Sets the country of this address.
| Parameter | Description |
|---|---|
country | the 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.
| Parameter | Description |
|---|---|
postcode | the postcode |
getModifiedBy()
Returns: Profile
The profile that last modified this address.
setModifiedBy(Profile modifiedBy)
Returns: void
Sets the profile that last modified this address.
| Parameter | Description |
|---|---|
modifiedBy | the 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.
| Parameter | Description |
|---|---|
modifiedDate | the last-modified date |