A single custom data capture field configured on a sales data series, wrapping its display order, name and raw configuration string for rendering in the series' admin edit form. Instances are built from the series' fieldset by getDataCaptureFieldList and are read-only - editing a field's name or specification is done through the addFieldName / removeFieldName commands on the owning ManageSalesDataSeriesFolder, not through this bean.
Properties
| Property | Returns | Description |
|---|---|---|
| fieldSpec | String | The field's raw, compact configuration string as stored on the series' fieldset, for example "text=Category;required=true;options(a,b,c)". Parse it with ExtraField.parse to get the field's type, label, required flag and options. |
| name | String | The field's name, used as the key when storing and looking up captured values on a sales data record. |
| ordinal | int | Position of this field relative to the series' other custom fields, used to order them in the admin edit form. |
Methods
getOrdinal()
Returns: int
Position of this field relative to the series' other custom fields, used to order them in the admin edit form.
getName()
Returns: String
The field's name, used as the key when storing and looking up captured values on a sales data record.
getFieldSpec()
Returns: String
The field's raw, compact configuration string as stored on the series' fieldset, for example "text=Category;required=true;options(a,b,c)". Parse it with ExtraField.parse to get the field's type, label, required flag and options.