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

Class FormValue

java.lang.Object

com.okta.idx.sdk.api.model.FormValue

public class FormValue
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.String	label	A user friendly name that could be used for a UI
Messages	messages	Error messages could appear here
boolean	mutable	Should this form value be mutable in a UI.
java.lang.String	name	The name of the form item that can be used in a UI.
Options[]	options
boolean	required	Indicates whether the item is a required field
boolean	secret	Is the value a secret value
java.lang.String	type	Describes the type of value that is expected
java.lang.Object	value	Default value for the current form value
boolean	visible	Should this form value be visible in a UI

Constructor Summary

Constructors

Constructor	Description
FormValue()

Method Summary

Modifier and Type	Method	Description
OptionsFormVal	form()	return an array of FormValue objects
OptionsFormVal	getForm()
java.lang.String	getLabel()
java.lang.String	getName()
java.lang.Object	getValue()
boolean	isRequired()
Options[]	options()	return a list of options that is described as an array of formValue
java.lang.String	relatesTo()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

public java.lang.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 java.lang.String label

A user friendly name that could be used for a UI

type

public java.lang.String type

Describes the type of value that is expected

secret

public boolean secret

Is the value a secret value

value

public java.lang.Object value

Default value for the current form value

options

public 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 Detail

FormValue

public FormValue()

Method Detail

relatesTo

public java.lang.String relatesTo()

form

public OptionsFormVal form()

return an array of FormValue objects

Returns:

OptionsFormVal array of FormValue

options

public Options[] options()

return a list of options that is described as an array of formValue

Returns:

Options array

getName

public java.lang.String getName()

isRequired

public boolean isRequired()

getValue

public java.lang.Object getValue()

getForm

public OptionsFormVal getForm()

getLabel

public java.lang.String getLabel()