Package io.dialob.api.form

Interface Form

All Superinterfaces:

FormEntity, Serializable, WithValidation<Form>

All Known Implementing Classes:

ImmutableForm, ModifiableForm

@Immutable
@Modifiable
@TypeAdapters(emptyAsNulls=true)
@Repository("forms")
public interface Form
extends WithValidation<Form>, FormEntity

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Form.Metadata

Method Summary

Modifier and Type	Method	Description
@Valid @NotNull Map<String,FormItem>	getData()
String	getId()
@Valid @NotNull Form.Metadata	getMetadata()
String	getName()
@Valid @NotNull Map<String,Form>	getNamespaces()
@NotNull Map<String,String>	getRequiredErrorText()
String	getRev()
@Valid @NotNull List<FormValueSet>	getValueSets()
@Valid @NotNull List<Variable>	getVariables()

Methods inherited from interface io.dialob.api.validation.WithValidation

validate

Method Details

getId

@Named("_id")
@Id
String getId()

getRev

@Named("_rev")
@Version
String getRev()

getName

String getName()

getData

@Valid
@NotNull
@Valid @NotNull Map<String,FormItem> getData()

getMetadata

@Valid
@NotNull
@Valid @NotNull Form.Metadata getMetadata()

getVariables

@Valid
@NotNull
@Valid @NotNull List<Variable> getVariables()

getNamespaces

@Valid
@NotNull
@Valid @NotNull Map<String,Form> getNamespaces()

getValueSets

@Valid
@NotNull
@Valid @NotNull List<FormValueSet> getValueSets()

getRequiredErrorText

@NotNull
@NotNull Map<String,String> getRequiredErrorText()

Returns:

error text for required fields, unless not defined per item