Package nz.org.riskscape.wizard

Interface QuestionSet

All Known Implementing Classes:

BaseQuestionSet, DefaultQuestionSet2, EmptyQuestionSet

public interface QuestionSet

A QuestionSet is a part of a Survey that groups together some questions that can apply a functionally similar set of changes to a PipelineDeclaration. The QuestionSet 'drives' the survey by offering Questions to the user and then plugging the answers in to update the PipelineDeclaration, via the IncrementalBuildState

Field Summary

Fields

Modifier and Type	Field	Description
static final Question	FINAL_QUESTION	Used as a unique question to act as a place for a final change to hang from - it needs a unique question for the change to hang from, otherwise IncrementalBuildState.append(PipelineChange, nz.org.riskscape.pipeline.ast.PipelineDeclaration, nz.org.riskscape.engine.pipeline.RealizedPipeline) will complain.
static final QuestionSet	SKIP	Presented to the user as a choice when optional QuestionSets can be skipped.
static final QuestionSet	UNASSIGNED	Used when a Question belongs to nothing (yet)

Method Summary

Modifier and Type	Method	Description
Optional<String>	getDescription(Locale locale)	A human-friendly description for this QuestionSet
String	getId()
default String	getName()
Phase	getPhase()
PipelineChange	getPipelineChange(IncrementalBuildState buildState, Answer answer)	Returns a PipelineChange that is created by applying an answer a build state.
default List<Question>	getQuestions()	The list of questions that this question set contains.
Survey	getSurvey()
Optional<String>	getTitle(Locale locale)	A human-friendly title for this QuestionSet

Field Details

FINAL_QUESTION

static final Question FINAL_QUESTION

Used as a unique question to act as a place for a final change to hang from - it needs a unique question for the change to hang from, otherwise IncrementalBuildState.append(PipelineChange, nz.org.riskscape.pipeline.ast.PipelineDeclaration, nz.org.riskscape.engine.pipeline.RealizedPipeline) will complain.

UNASSIGNED

static final QuestionSet UNASSIGNED

Used when a Question belongs to nothing (yet)

SKIP

static final QuestionSet SKIP

Presented to the user as a choice when optional QuestionSets can be skipped.

Method Details

getId

String getId()

Returns:

a String that uniquely identifies this QuestionSet TODO this might become a name and end up being a weak identifier, as the name is probably only unique within the context of a survey

getTitle

Optional<String> getTitle(Locale locale)

A human-friendly title for this QuestionSet

getDescription

Optional<String> getDescription(Locale locale)

A human-friendly description for this QuestionSet

getPipelineChange

PipelineChange getPipelineChange(IncrementalBuildState buildState,
 Answer answer)

Returns a PipelineChange that is created by applying an answer a build state.

Parameters:

buildState - the build state to get a change to.

answer - the answer to apply. This answer must be for a question that came back from #getNextQuestions(IncrementalBuildState) using the given build state, or weird things might happen

getSurvey

Survey getSurvey()

Returns:

the survey to which this set belongs

getQuestions

default List<Question> getQuestions()

The list of questions that this question set contains.

These questions should be partially ordered such that if question b comes after question a then they should be ordered so that a is before b in the list.

Previously, there was potential for this list to change as the build state changed, and so this method was removed from the QuestionSet interface. But this possibility is being dropped with the new survey2 api in favour of a static list of questions per set, but allowing a dynamic set of question sets.

getName

default String getName()

getPhase

Phase getPhase()

Returns:

the phase this QuestionSet belongs to