Package com.okta.idx.sdk.api.model

Class FormValue

java.lang.Object
com.okta.idx.sdk.api.model.FormValue
All Implemented Interfaces:
Serializable
public class FormValue extends Object implements Serializable
See Also:

  • Field Details

    • name

      public String name
      The name of the form item that can be used in a UI. This relates to the name that is used for the body of the request for the RemediationStep.

    • required

      public boolean required
      Indicates whether the item is a required field

    • label

      public String label
      A user-friendly name that could be used for a UI

    • type

      public String type
      Describes the type of value that is expected

    • secret

      public boolean secret
      Is the value a secret value

    • value

      public Object value
      Default value for the current form value

    • options

      public List<Options> options

    • visible

      public boolean visible
      Should this form value be visible in a UI

    • mutable

      public boolean mutable
      Should this form value be mutable in a UI. MAY relate to the form fields disabled property

    • messages

      public Messages messages
      Error messages could appear here

  • Constructor Details

    • FormValue

      public FormValue()

  • Method Details

    • relatesTo

      public String relatesTo()

    • form

      public OptionsFormVal form()
      return an array of FormValue objects
      Returns:
      OptionsFormVal array of FormValue

    • options

      public List<Options> options()
      return a list of options that is described as an array of formValue
      Returns:
      Options array

    • getName

      public String getName()

    • isRequired

      public boolean isRequired()

    • getValue

      public Object getValue()

    • getForm

      public OptionsFormVal getForm()

    • getLabel

      public String getLabel()

    • value

      public Object value()