Package io.dialob.client.api

Interface QuestionnaireSession

All Known Implementing Classes:

QuestionnaireSessionImpl

@Enclosing
public interface QuestionnaireSession

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	QuestionnaireSession.DispatchActionsResult
static class	QuestionnaireSession.QuestionClientVisibility
static class	QuestionnaireSession.State
static interface	QuestionnaireSession.UpdatesCallback

Method Summary

Modifier and Type	Method	Description
void	activate()
void	buildFullForm(QuestionnaireSession.UpdatesCallback updatesCallback)
void	close()
QuestionnaireSession.DispatchActionsResult	dispatchActions(String revision, Collection<io.dialob.api.proto.Action> actions)	Deprecated. session should always generate updates.
QuestionnaireSession.DispatchActionsResult	dispatchActions(Collection<io.dialob.api.proto.Action> actions)
Optional<String>	getActiveItem()
List<io.dialob.api.questionnaire.Answer>	getAnswers()
List<io.dialob.api.questionnaire.Error>	getErrors()
String	getFormId()
Optional<io.dialob.api.proto.ActionItem>	getItemById(String itemId)
List<io.dialob.api.proto.ActionItem>	getItems()
Instant	getLastUpdate()
Optional<Locale>	getLocale()
String	getOwner()
QuestionnaireSession.QuestionClientVisibility	getQuestionClientVisibility()
io.dialob.api.questionnaire.Questionnaire	getQuestionnaire()
String	getRev()
String	getRevision()
Optional<String>	getSessionId()
io.dialob.api.questionnaire.Questionnaire.Metadata.Status	getStatus()
String	getTenantId()
List<io.dialob.api.proto.ValueSet>	getValueSets()
List<io.dialob.api.questionnaire.VariableValue>	getVariableValues()
List<io.dialob.api.proto.ActionItem>	getVisibleItems()
boolean	isActive()
boolean	isCompleted()
void	passivate()
boolean	usesLastestFormRevision()
QuestionnaireSession	withIdAndRev(String id, String rev)

Method Detail

dispatchActions

@Deprecated
@Nonnull
QuestionnaireSession.DispatchActionsResult dispatchActions(String revision,
                                                           @Nonnull
                                                           Collection<io.dialob.api.proto.Action> actions)

Deprecated.

session should always generate updates. Client connectors should check state of session and choose to send updates or full form

Returns:

update actions

dispatchActions

@Nonnull
QuestionnaireSession.DispatchActionsResult dispatchActions(@Nonnull
                                                           Collection<io.dialob.api.proto.Action> actions)

getQuestionnaire

@Nonnull
io.dialob.api.questionnaire.Questionnaire getQuestionnaire()

getRevision

@Nonnull
String getRevision()

getRev

String getRev()

getOwner

String getOwner()

getLastUpdate

@Nonnull
Instant getLastUpdate()

getActiveItem

Optional<String> getActiveItem()

getValueSets

@Nonnull
List<io.dialob.api.proto.ValueSet> getValueSets()

getErrors

@Nonnull
List<io.dialob.api.questionnaire.Error> getErrors()

getItems

@Nonnull
List<io.dialob.api.proto.ActionItem> getItems()

getItemById

Optional<io.dialob.api.proto.ActionItem> getItemById(@Nonnull
                                                     String itemId)

getVisibleItems

@Nonnull
List<io.dialob.api.proto.ActionItem> getVisibleItems()

getAnswers

@Nonnull
List<io.dialob.api.questionnaire.Answer> getAnswers()

getVariableValues

@Nonnull
List<io.dialob.api.questionnaire.VariableValue> getVariableValues()

buildFullForm

void buildFullForm(@Nonnull
                   QuestionnaireSession.UpdatesCallback updatesCallback)

getSessionId

Optional<String> getSessionId()

getTenantId

String getTenantId()

activate

void activate()

passivate

void passivate()

isActive

boolean isActive()

isCompleted

boolean isCompleted()

usesLastestFormRevision

boolean usesLastestFormRevision()

getFormId

@Nonnull
String getFormId()

getLocale

Optional<Locale> getLocale()

getQuestionClientVisibility

QuestionnaireSession.QuestionClientVisibility getQuestionClientVisibility()

withIdAndRev

QuestionnaireSession withIdAndRev(String id,
                                  String rev)

getStatus

@Nonnull
io.dialob.api.questionnaire.Questionnaire.Metadata.Status getStatus()

close

void close()