Attaches an Address to a profile or organisation, with a type saying what the address is used for. The Address record holds the address lines themselves and can be shared, so this join record is what makes an address belong to somebody. An entity can have several of these, one per address type, for example a billing address and a delivery address, and the addressType is free text rather than a fixed set. Everything is scoped by the admin organisation.

Group: Database Entities

Implements: Serializable, Relational


Properties

PropertyReturnsDescription
addressAddressThe address itself, holding the street lines, suburb, postcode and country. Always set.
addressForBaseEntityThe profile or organisation the address belongs to. Always set, and typed as BaseEntity because either can hold an address.
addressTypeStringWhat the address is used for, for example billing or delivery. Free text set by whatever created the record rather than a fixed list, so compare it with care.
adminOrgOrganisationThe account, ie the top level administrative organisation, this record belongs to. Always set, and every lookup is scoped by it.
createdDateDateWhen the address was first attached to the entity.
idlongThe database-assigned unique identifier for this entity address.
modifiedByProfileThe profile who last changed this link. Can be null when the record was created outside a logged in session, for example by an import.
modifiedDateDateWhen this link was last changed. Set to the creation time when the record is first made.

Methods

getId() · getAdminOrg() · getAddressFor() · getAddress() · getAddressType() · getCreatedDate() · getModifiedDate() · getModifiedBy() · rowId()

getId()

Returns: long

The database-assigned unique identifier for this entity address.

getAdminOrg()

Returns: Organisation

The account, ie the top level administrative organisation, this record belongs to. Always set, and every lookup is scoped by it.

getAddressFor()

Returns: BaseEntity

The profile or organisation the address belongs to. Always set, and typed as BaseEntity because either can hold an address.

getAddress()

Returns: Address

The address itself, holding the street lines, suburb, postcode and country. Always set.

getAddressType()

Returns: String

What the address is used for, for example billing or delivery. Free text set by whatever created the record rather than a fixed list, so compare it with care.

getCreatedDate()

Returns: Date

When the address was first attached to the entity.

getModifiedDate()

Returns: Date

When this link was last changed. Set to the creation time when the record is first made.

getModifiedBy()

Returns: Profile

The profile who last changed this link. Can be null when the record was created outside a logged in session, for example by an import.

rowId()

Returns: Long

The database identifier for this record, as the generic row id used across Kademi entities. Same value as the id.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.