To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
An alternative, unique way of identifying a member within an organisation, such as a payroll number, a dealer code or an external system's customer id. Identifiers are created from extra fields whose options string contains profid(), and let a member be looked up by that value instead of by username, which is what makes them usable for imports, single sign-on and password reset. A member has at most one value per identifier name within an organisation, and a value is expected to belong to only one member, so saving a duplicate is rejected. The same member can hold different identifiers in different organisations.
Group: Database Entities
Implements: Serializable, Relational
Properties
| Property | Returns | Description |
|---|---|---|
| createdDate | Date | When this identifier was first recorded for the member. |
| id | Long | The database identifier of this identifier row. |
| idName | String | Which kind of identifier this is, taken from the name of the extra field that defines it, for example payrollNumber. A member holds at most one value per name within an organisation. Never null. |
| idValue | String | The identifying value itself, such as the actual payroll number. Expected to be unique across members for a given name and organisation, and saving a value already held by another member is rejected. |
| modifiedDate | Date | When the value was last changed. Stamped every time the identifier is saved, including the first time. |
| profile | Profile | The member this identifier belongs to. Never null for a persisted row. |
| withinOrg | Organisation | The organisation the identifier is unique within. The same member can hold different identifiers in different organisations, so every lookup is scoped by this. Never null. |
Methods
getId() · getProfile() · setProfile(Profile profile) · getWithinOrg() · setWithinOrg(Organisation withinOrg) · getIdName() · setIdName(String idName) · getIdValue() · setIdValue(String idValue) · getCreatedDate() · setCreatedDate(Date createdDate) · getModifiedDate() · setModifiedDate(Date modifiedDate) · rowId()
getId()
Returns: Long
The database identifier of this identifier row.
getProfile()
Returns: Profile
The member this identifier belongs to. Never null for a persisted row.
setProfile(Profile profile)
Returns: void
Sets the member this identifier belongs to.
| Parameter | Description |
|---|---|
profile | the member being identified |
getWithinOrg()
Returns: Organisation
The organisation the identifier is unique within. The same member can hold different identifiers in different organisations, so every lookup is scoped by this. Never null.
setWithinOrg(Organisation withinOrg)
Returns: void
Sets the organisation the identifier is unique within.
| Parameter | Description |
|---|---|
withinOrg | the organisation the identifier is scoped to |
getIdName()
Returns: String
Which kind of identifier this is, taken from the name of the extra field that defines it, for example payrollNumber. A member holds at most one value per name within an organisation. Never null.
setIdName(String idName)
Returns: void
Sets which kind of identifier this is.
| Parameter | Description |
|---|---|
idName | the identifier's field name, which must not be null |
getIdValue()
Returns: String
The identifying value itself, such as the actual payroll number. Expected to be unique across members for a given name and organisation, and saving a value already held by another member is rejected.
setIdValue(String idValue)
Returns: void
Sets the identifying value.
| Parameter | Description |
|---|---|
idValue | the identifier value |
getCreatedDate()
Returns: Date
When this identifier was first recorded for the member.
setCreatedDate(Date createdDate)
Returns: void
Sets the date this identifier was first recorded.
| Parameter | Description |
|---|---|
createdDate | the date the identifier was created |
getModifiedDate()
Returns: Date
When the value was last changed. Stamped every time the identifier is saved, including the first time.
setModifiedDate(Date modifiedDate)
Returns: void
Sets the date the value was last changed.
| Parameter | Description |
|---|---|
modifiedDate | the date the value last changed |
rowId()
Returns: Long
The database identifier of this identifier row, as required by the Relational interface.
© 2025 Kademi Ltd