A label that points credits and debits can be grouped under, so an account can separate its points into named pools. A Points record can carry a tag, which lets reporting and balances be broken down by, for example, sales points versus training points. Tags are per organisation and identified by a name that is unique within it. They are soft-deleted rather than removed: deleting one stamps deletedBy and deletedDate and renames it with a timestamp suffix, so existing points keep their tag and the old name becomes available again.

Group: Database Entities

Implements: Serializable, Relational


Properties

PropertyReturnsDescription
deletedByProfileThe profile who deleted the tag. Null while the tag is live, so this doubles as the deleted flag: listings only return tags where it is null.
deletedDateDateWhen the tag was deleted, or null while it is still live. The same timestamp is appended to the name on delete.
idlongThe database-assigned unique identifier for this tag.
nameStringThe portable, path-safe identifier for the tag, unique within the organisation and used to look it up. Note that deleting a tag appends an underscore and a timestamp to this value, so a deleted tag's name is not the one it was created with.
notesStringFree text describing what the tag is for, shown to administrators. Usually null.
titleStringThe human readable label shown to users. Free text with no uniqueness guarantee, and unlike the name it is left alone when the tag is deleted.

Methods

getId()

Returns: long

The database-assigned unique identifier for this tag.

getName()

Returns: String

The portable, path-safe identifier for the tag, unique within the organisation and used to look it up. Note that deleting a tag appends an underscore and a timestamp to this value, so a deleted tag's name is not the one it was created with.

getTitle()

Returns: String

The human readable label shown to users. Free text with no uniqueness guarantee, and unlike the name it is left alone when the tag is deleted.

getNotes()

Returns: String

Free text describing what the tag is for, shown to administrators. Usually null.

getDeletedBy()

Returns: Profile

The profile who deleted the tag. Null while the tag is live, so this doubles as the deleted flag: listings only return tags where it is null.

getDeletedDate()

Returns: Date

When the tag was deleted, or null while it is still live. The same timestamp is appended to the name on delete.

rowId()

Returns: Long

The database identifier for this tag, 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.