To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
One extra named value captured against a learner's progress through a module, for anything the fixed ModuleStatus columns do not cover. What should be captured is defined elsewhere, and the value is always stored as text, so the reader needs to know the intended type to parse it. Fields are deleted along with the module status when progress is reset or renewed.
Group: Database Entities
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| id | Long | The database identifier of this captured field. |
| modDate | Date | When the value was last set. Stored as a date only, with no time part, and it is the field the finder methods sort on. May be null. |
| moduleStatus | ModuleStatus | The learner's module progress record this field was captured against. |
| name | String | The name of the captured field, which is the key the data capture definition gives it. Never null. |
| propValue | String | The captured value, always held as text and limited to 10000 characters. Numbers, dates and booleans are stored in their string form, so parse it using the type named in the data capture definition. Never null. |
Methods
getId() · getName() · setName(String name) · getPropValue() · setPropValue(String propValue) · getModuleStatus() · setModuleStatus(ModuleStatus moduleStatus) · getModDate() · setModDate(Date modDate)
getId()
Returns: Long
The database identifier of this captured field.
getName()
Returns: String
The name of the captured field, which is the key the data capture definition gives it. Never null.
setName(String name)
Returns: void
Sets the name of the captured field.
| Parameter | Description |
|---|---|
name | the field's name |
getPropValue()
Returns: String
The captured value, always held as text and limited to 10000 characters. Numbers, dates and booleans are stored in their string form, so parse it using the type named in the data capture definition. Never null.
setPropValue(String propValue)
Returns: void
Sets the captured value, as text.
| Parameter | Description |
|---|---|
propValue | the field's value in string form, at most 10000 characters |
getModuleStatus()
Returns: ModuleStatus
The learner's module progress record this field was captured against.
setModuleStatus(ModuleStatus moduleStatus)
Returns: void
Sets the module progress record this field was captured against.
| Parameter | Description |
|---|---|
moduleStatus | the owning module status |
getModDate()
Returns: Date
When the value was last set. Stored as a date only, with no time part, and it is the field the finder methods sort on. May be null.
setModDate(Date modDate)
Returns: void
Sets when the value was last set.
| Parameter | Description |
|---|---|
modDate | the date the field was last modified |
© 2025 Kademi Ltd