A NvPair is to allow data capture for entities such as users, groups and organisations Every NvPair is associated with a NvSet. The owning entity should have a reference to the set. NvPairs and sets should be considered immutable, so instead of updating the value, create a new set with a new NvPair for each item, and then link the owning entity to the set. Remember to set the previousSetId on the new set to the previous set to allow navigating old versions The definition of what needs to be captured is held elsewhere. Values are stored in a string representation. Knowledge of the type of the data in the data capture definition is required to parse the value
Group: Database Entities
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| id | Long | Generated primary key of the name and value pair. Null until the record has been saved. |
| name | String | The field name this value was captured against, matching the name in the data capture definition held elsewhere. Never null, and unique within the owning set. |
| nvSet | NvSet | The set this pair belongs to, which is what the owning user, group or organisation actually points at. Never null. Sets and pairs are treated as immutable, so a change means creating a new set rather than editing this value. |
| propValue | String | The captured value, always held as text of up to 20000 characters regardless of the field's real type. Converting it back to a number, date or boolean needs the type from the data capture definition. Never null, though it may be an empty string. |
Methods
getId()
Returns: Long
Generated primary key of the name and value pair. Null until the record has been saved.
getName()
Returns: String
The field name this value was captured against, matching the name in the data capture definition held elsewhere. Never null, and unique within the owning set.
getPropValue()
Returns: String
The captured value, always held as text of up to 20000 characters regardless of the field's real type. Converting it back to a number, date or boolean needs the type from the data capture definition. Never null, though it may be an empty string.
getNvSet()
Returns: NvSet
The set this pair belongs to, which is what the owning user, group or organisation actually points at. Never null. Sets and pairs are treated as immutable, so a change means creating a new set rather than editing this value.