To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Named category used to file email jobs under an organisation so administrators can group and browse them. Each category belongs to exactly one organisation and carries a type string, which keeps independent sets of categories apart in the same table. Deleting a category detaches it from the email jobs that used it rather than deleting those jobs.
Group: Database Entities
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| id | long | Database identifier for this category, assigned when the row is first saved. |
| name | String | Portable, path-safe identifier for the category, intended to be unique within the organisation and used as the lookup key. This is not the label shown to users. |
| notes | String | Optional administrator notes describing what the category is used for, up to 3000 characters. Null when nothing has been recorded. |
| org | Organisation | The organisation the category belongs to. Categories are only offered to email jobs in the same organisation, so this is never null. |
| title | String | Free text display label shown to administrators. Unlike the name it carries no uniqueness or path-safety guarantee, and may be edited at any time. |
| type | String | Discriminator which keeps independent sets of categories apart within the same table. It is supplied when the category is created, and listing categories for an organisation filters on it, so only categories of the requested type are returned. |
Methods
getId()
Returns: long
Database identifier for this category, assigned when the row is first saved.
getName()
Returns: String
Portable, path-safe identifier for the category, intended to be unique within the organisation and used as the lookup key. This is not the label shown to users.
getTitle()
Returns: String
Free text display label shown to administrators. Unlike the name it carries no uniqueness or path-safety guarantee, and may be edited at any time.
getOrg()
Returns: Organisation
The organisation the category belongs to. Categories are only offered to email jobs in the same organisation, so this is never null.
getNotes()
Returns: String
Optional administrator notes describing what the category is used for, up to 3000 characters. Null when nothing has been recorded.
getType()
Returns: String
Discriminator which keeps independent sets of categories apart within the same table. It is supplied when the category is created, and listing categories for an organisation filters on it, so only categories of the requested type are returned.
© 2025 Kademi Ltd