Package io.dialob.api.questionnaire

Class ModifiableQuestionnaire

java.lang.Object
io.dialob.api.questionnaire.ModifiableQuestionnaire
All Implemented Interfaces:
Questionnaire, WithValidation<Questionnaire>, Serializable
@ParametersAreNonnullByDefault @Generated({"Modifiables.generator","Questionnaire"}) @NotThreadSafe public final class ModifiableQuestionnaire extends Object implements Questionnaire
A modifiable implementation of the Questionnaire type.

Use the create() static factory methods to create new instances. Use the toImmutable() method to convert to canonical immutable instances.

ModifiableQuestionnaire is not thread-safe

See Also:

  • Method Details

    • create

      public static ModifiableQuestionnaire create()
      Construct a modifiable instance of Questionnaire.
      Returns:
      A new modifiable instance

    • getId

      public final String getId()
      Specified by:
      getId in interface Questionnaire
      Returns:
      value of id attribute, may be null

    • getRev

      public final String getRev()
      Specified by:
      getRev in interface Questionnaire
      Returns:
      value of rev attribute, may be null

    • getAnswers

      public final List<Answer> getAnswers()
      Specified by:
      getAnswers in interface Questionnaire
      Returns:
      modifiable list answers

    • getContext

      public final List<ContextValue> getContext()
      Specified by:
      getContext in interface Questionnaire
      Returns:
      modifiable list context

    • getActiveItem

      public final String getActiveItem()
      Specified by:
      getActiveItem in interface Questionnaire
      Returns:
      value of activeItem attribute, may be null

    • getErrors

      public final List<Error> getErrors()
      Specified by:
      getErrors in interface Questionnaire
      Returns:
      modifiable list errors

    • getVariableValues

      public final List<VariableValue> getVariableValues()
      Specified by:
      getVariableValues in interface Questionnaire
      Returns:
      modifiable list variableValues

    • getValueSets

      public final List<ValueSet> getValueSets()
      Specified by:
      getValueSets in interface Questionnaire
      Returns:
      modifiable list valueSets

    • getMetadata

      public final ModifiableQuestionnaireMetadata getMetadata()
      Specified by:
      getMetadata in interface Questionnaire
      Returns:
      value of metadata attribute, may be null

    • clear

      public ModifiableQuestionnaire clear()
      Clears the object by setting all attributes to their initial values.
      Returns:
      this for use in a chained invocation

    • from

      public ModifiableQuestionnaire from(Questionnaire instance)
      Fill this modifiable instance with attribute values from the provided Questionnaire instance. Regular attribute values will be overridden, i.e. replaced with ones of an instance. Any of the instance's absent optional values will not be copied (will not override current values). Collection elements and entries will be added, not replaced.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this for use in a chained invocation

    • from

      public ModifiableQuestionnaire from(ModifiableQuestionnaire instance)
      Fill this modifiable instance with attribute values from the provided Questionnaire instance. Regular attribute values will be overridden, i.e. replaced with ones of an instance. Any of the instance's absent optional values will not be copied (will not override current values). Collection elements and entries will be added, not replaced.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this for use in a chained invocation

    • setId

      public ModifiableQuestionnaire setId(String id)
      Assigns a value to the id attribute.
      Parameters:
      id - The value for id, can be null
      Returns:
      this for use in a chained invocation

    • setRev

      public ModifiableQuestionnaire setRev(String rev)
      Assigns a value to the rev attribute.
      Parameters:
      rev - The value for rev, can be null
      Returns:
      this for use in a chained invocation

    • addAnswers

      public ModifiableQuestionnaire addAnswers(Answer element)
      Adds one element to answers list.
      Parameters:
      element - The answers element
      Returns:
      this for use in a chained invocation

    • addAnswers

      public final ModifiableQuestionnaire addAnswers(Answer... elements)
      Adds elements to answers list.
      Parameters:
      elements - An array of answers elements
      Returns:
      this for use in a chained invocation

    • setAnswers

      public ModifiableQuestionnaire setAnswers(Iterable<? extends Answer> elements)
      Sets or replaces all elements for answers list.
      Parameters:
      elements - An iterable of answers elements
      Returns:
      this for use in a chained invocation

    • addAllAnswers

      public ModifiableQuestionnaire addAllAnswers(Iterable<? extends Answer> elements)
      Adds elements to answers list.
      Parameters:
      elements - An iterable of answers elements
      Returns:
      this for use in a chained invocation

    • addContext

      public ModifiableQuestionnaire addContext(ContextValue element)
      Adds one element to context list.
      Parameters:
      element - The context element
      Returns:
      this for use in a chained invocation

    • addContext

      public final ModifiableQuestionnaire addContext(ContextValue... elements)
      Adds elements to context list.
      Parameters:
      elements - An array of context elements
      Returns:
      this for use in a chained invocation

    • setContext

      public ModifiableQuestionnaire setContext(Iterable<? extends ContextValue> elements)
      Sets or replaces all elements for context list.
      Parameters:
      elements - An iterable of context elements
      Returns:
      this for use in a chained invocation

    • addAllContext

      public ModifiableQuestionnaire addAllContext(Iterable<? extends ContextValue> elements)
      Adds elements to context list.
      Parameters:
      elements - An iterable of context elements
      Returns:
      this for use in a chained invocation

    • setActiveItem

      public ModifiableQuestionnaire setActiveItem(String activeItem)
      Assigns a value to the activeItem attribute.
      Parameters:
      activeItem - The value for activeItem, can be null
      Returns:
      this for use in a chained invocation

    • addErrors

      public ModifiableQuestionnaire addErrors(Error element)
      Adds one element to errors list.
      Parameters:
      element - The errors element
      Returns:
      this for use in a chained invocation

    • addErrors

      public final ModifiableQuestionnaire addErrors(Error... elements)
      Adds elements to errors list.
      Parameters:
      elements - An array of errors elements
      Returns:
      this for use in a chained invocation

    • setErrors

      public ModifiableQuestionnaire setErrors(Iterable<? extends Error> elements)
      Sets or replaces all elements for errors list.
      Parameters:
      elements - An iterable of errors elements
      Returns:
      this for use in a chained invocation

    • addAllErrors

      public ModifiableQuestionnaire addAllErrors(Iterable<? extends Error> elements)
      Adds elements to errors list.
      Parameters:
      elements - An iterable of errors elements
      Returns:
      this for use in a chained invocation

    • addVariableValues

      public ModifiableQuestionnaire addVariableValues(VariableValue element)
      Adds one element to variableValues list.
      Parameters:
      element - The variableValues element
      Returns:
      this for use in a chained invocation

    • addVariableValues

      public final ModifiableQuestionnaire addVariableValues(VariableValue... elements)
      Adds elements to variableValues list.
      Parameters:
      elements - An array of variableValues elements
      Returns:
      this for use in a chained invocation

    • setVariableValues

      public ModifiableQuestionnaire setVariableValues(Iterable<? extends VariableValue> elements)
      Sets or replaces all elements for variableValues list.
      Parameters:
      elements - An iterable of variableValues elements
      Returns:
      this for use in a chained invocation

    • addAllVariableValues

      public ModifiableQuestionnaire addAllVariableValues(Iterable<? extends VariableValue> elements)
      Adds elements to variableValues list.
      Parameters:
      elements - An iterable of variableValues elements
      Returns:
      this for use in a chained invocation

    • addValueSets

      public ModifiableQuestionnaire addValueSets(ValueSet element)
      Adds one element to valueSets list.
      Parameters:
      element - The valueSets element
      Returns:
      this for use in a chained invocation

    • addValueSets

      public final ModifiableQuestionnaire addValueSets(ValueSet... elements)
      Adds elements to valueSets list.
      Parameters:
      elements - An array of valueSets elements
      Returns:
      this for use in a chained invocation

    • setValueSets

      public ModifiableQuestionnaire setValueSets(Iterable<? extends ValueSet> elements)
      Sets or replaces all elements for valueSets list.
      Parameters:
      elements - An iterable of valueSets elements
      Returns:
      this for use in a chained invocation

    • addAllValueSets

      public ModifiableQuestionnaire addAllValueSets(Iterable<? extends ValueSet> elements)
      Adds elements to valueSets list.
      Parameters:
      elements - An iterable of valueSets elements
      Returns:
      this for use in a chained invocation

    • setMetadata

      public ModifiableQuestionnaire setMetadata(Questionnaire.Metadata metadata)
      Assigns a value to the metadata attribute.
      Parameters:
      metadata - The value for metadata, can be null
      Returns:
      this for use in a chained invocation

    • isInitialized

      public final boolean isInitialized()
      Returns true if all required attributes are set, indicating that the object is initialized.
      Returns:
      true if set

    • toImmutable

      public final ImmutableQuestionnaire toImmutable()
      Converts to ImmutableQuestionnaire.
      Returns:
      An immutable instance of Questionnaire

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ModifiableQuestionnaire that have equal attribute values.
      Overrides:
      equals in class Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: id, rev, answers, context, activeItem, errors, variableValues, valueSets, metadata.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Generates a string representation of this Questionnaire. If uninitialized, some attribute values may appear as question marks.
      Overrides:
      toString in class Object
      Returns:
      A string representation