JSON-serializable snapshot of a Field, produced by FieldsService for sending field metadata to the admin UI. A FieldBean carries the same id, label, type, input, values and operators as its source Field, plus a placeholder string wrapped in the kcode markers and a flattened parentTypes list that includes any registered sub types of each declared parent type.


Properties

PropertyReturnsDescription
idStringUnique internal identifier for this field, copied from the source field.
inputStringName of the input control the admin UI should use to edit this field's value, for example select or radio, or null when no special input control is required.
labelStringHuman readable label for this field, copied from the source field.
operatorsList<String>Names of the comparison operators this field supports, such as equal or in.
parentTypesList<String>Names of the parent entity types this field applies to as a child property, expanded to include any sub types registered against each declared parent type. Null when the field is not restricted to particular parent types.
placeholderStringThe field id wrapped in the kcode prefix and suffix markers, ready to paste into a template as a placeholder that FieldsService will substitute with the field's evaluated value.
typeStringData type of this field's value, for example string or integer, copied from the source field.
valuesList<String>Allowed selectable values for this field, when it is restricted to a fixed set of options. Null or empty when the field accepts free-form values.
versionintVersion of the field system the source field belongs to.

Methods

getId() · getPlaceholder() · getLabel() · getType() · getInput() · getValues() · getOperators() · getParentTypes() · getVersion()

getId()

Returns: String

Unique internal identifier for this field, copied from the source field.

getPlaceholder()

Returns: String

The field id wrapped in the kcode prefix and suffix markers, ready to paste into a template as a placeholder that FieldsService will substitute with the field's evaluated value.

getLabel()

Returns: String

Human readable label for this field, copied from the source field.

getType()

Returns: String

Data type of this field's value, for example string or integer, copied from the source field.

getInput()

Returns: String

Name of the input control the admin UI should use to edit this field's value, for example select or radio, or null when no special input control is required.

getValues()

Returns: List<String>

Allowed selectable values for this field, when it is restricted to a fixed set of options. Null or empty when the field accepts free-form values.

getOperators()

Returns: List<String>

Names of the comparison operators this field supports, such as equal or in.

getParentTypes()

Returns: List<String>

Names of the parent entity types this field applies to as a child property, expanded to include any sub types registered against each declared parent type. Null when the field is not restricted to particular parent types.

getVersion()

Returns: int

Version of the field system the source field belongs to.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.