Hierarchy

public interface Hierarchy implements FieldDefinition

Details of a hierarchical or tree field.

Usually displayed as a collapsing tree, with each node displaying text corresponding to the label field of the corresponding HierarchyNode. The value of the field can only be set to one of the HierarchyNode.nodeId values from the hierarchy of nodes, where the corresponding HierarchyNode.isLeaf property is true.

Functions

Link copied to clipboard
public abstract String getFieldId()

Identifier for the field.

Link copied to clipboard
public abstract String getLabel()

Human-readable label for the field.

Link copied to clipboard
public abstract Sequence<HierarchyNode<String>> getValues()

Top level options.

Link copied to clipboard
public abstract Boolean isRequired()

True iff the value is required. This is only valid for fields within a survey

Link copied to clipboard
public abstract Unit validate(String value)

Check if value is valid for this field definition.