Package com.flowable.questionnaire.api

Interface Questionnaire

All Known Subinterfaces:
QuestionnaireEntity
All Known Implementing Classes:
QuestionnaireEntityImpl
public interface Questionnaire
Represents a single questionnaire instance with the current question and optionally with previous question data
Author:
Filip Hrisafov, Micha Kiener

  • Method Summary

    Modifier and Type Method Description
    Question getCurrentQuestion()
    Returns the currently open question within this questionnaire, if any, might be null for a finished questionnaire.
    java.lang.String getId()
    Returns the unique id of this questionnaire.
    java.lang.String getModelName()
    Returns the name of the questionnaire model behind this questionnaire instance.
    java.util.Map<java.lang.String,​java.lang.Object> getParameters()
    The parameters that were used to start the questionnaire.
    java.util.List<Question> getPreviousQuestions()
    If requested as a full questionnaire instance data object, this list contains all the previously answered questions.

  • Method Details

    • getId

      java.lang.String getId()
      Returns the unique id of this questionnaire.
      Returns:
      the id of the questionnaire

    • getModelName

      java.lang.String getModelName()
      Returns the name of the questionnaire model behind this questionnaire instance.
      Returns:
      the name of the model behind this questionnaire

    • getParameters

      java.util.Map<java.lang.String,​java.lang.Object> getParameters()
      The parameters that were used to start the questionnaire.
      Returns:
      the optional parameters of the questionnaire, might be empty or even null

    • getCurrentQuestion

      Question getCurrentQuestion()
      Returns the currently open question within this questionnaire, if any, might be null for a finished questionnaire.
      Returns:
      the currently open question or null, if no more open questions

    • getPreviousQuestions

      java.util.List<Question> getPreviousQuestions()
      If requested as a full questionnaire instance data object, this list contains all the previously answered questions.
      Returns:
      a list of already answered questions, might be null or empty