A grouping for sales data series, used to organise an account's series into sections in reporting and admin screens. A SalesDataSeries optionally belongs to one of these, so the category is purely a way of grouping series rather than anything that affects the data itself. Categories are per organisation. Deleting a category does not delete its series, it simply detaches them, so they become uncategorised rather than disappearing.
Group: Database Entities
Implements: Serializable, Relational
Properties
| Property | Returns | Description |
|---|---|---|
| id | long | The database-assigned unique identifier for this category. |
| name | String | The portable, path-safe identifier for the category, unique within the organisation and used to look it up in code and URLs. Always set. |
| notes | String | Free text describing what the category is for, shown to administrators. Usually null. |
| org | Organisation | The organisation that owns this category. Always set, and category names are only unique within it. |
| title | String | The human readable label shown to users. Free text with no uniqueness guarantee, so use the name when you need an identifier. |
Methods
getId()
Returns: long
The database-assigned unique identifier for this category.
getName()
Returns: String
The portable, path-safe identifier for the category, unique within the organisation and used to look it up in code and URLs. Always set.
getTitle()
Returns: String
The human readable label shown to users. Free text with no uniqueness guarantee, so use the name when you need an identifier.
getOrg()
Returns: Organisation
The organisation that owns this category. Always set, and category names are only unique within it.
getNotes()
Returns: String
Free text describing what the category is for, shown to administrators. Usually null.
rowId()
Returns: Long
The database identifier for this category, as the generic row id used across Kademi entities. Same value as the id.