net.nemerosa.ontrack.model.form.Field.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ontrack-model Show documentation

Ontrack module: ontrack-model

There is a newer version: 4.4.5

package net.nemerosa.ontrack.model.form

/**
 * Definition of a [Form] field.
 */
interface Field {

    /**
     * ID identifying the type of field. Used for mapping as client side.
     */
    val type: String

    /**
     * Name of this field in the form.
     */
    val name: String

    /**
     * Label associated with this field
     */
    val label: String

    /**
     * Help text for this field (optional).
     */
    val help: String

    /**
     * Value associated with this field. Can be `null`.
     */
    val value: Any?

    /**
     * Associates a value with this field and returns a field instance.
     */
    fun value(value: Any?): Field
}