Package io.dialob.session.engine.sp

Class DialobQuestionnaireSession

java.lang.Object

io.dialob.session.engine.sp.DialobQuestionnaireSession

All Implemented Interfaces:

QuestionnaireSession

public class DialobQuestionnaireSession
extends Object
implements QuestionnaireSession

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DialobQuestionnaireSession.Builder
static enum	DialobQuestionnaireSession.State

Nested classes/interfaces inherited from interface io.dialob.questionnaire.service.api.session.QuestionnaireSession

QuestionnaireSession.DispatchActionsResult, QuestionnaireSession.QuestionClientVisibility, QuestionnaireSession.UpdatesCallback

Method Summary

Modifier and Type	Method	Description
boolean	activate()
static DialobQuestionnaireSession.Builder	builder()
void	buildFullForm(QuestionnaireSession.UpdatesCallback updatesCallback)
void	close()
QuestionnaireSession.DispatchActionsResult	dispatchActions(String revision, Collection<io.dialob.api.proto.Action> actions)
QuestionnaireSession.DispatchActionsResult	dispatchActions(Collection<io.dialob.api.proto.Action> actions)
Optional<String>	getActiveItem()
Set<String>	getActiveItems()
List<io.dialob.api.questionnaire.Answer>	getAnswers()
DialobProgram	getDialobProgram()
DialobSession	getDialobSession()
List<io.dialob.api.questionnaire.Error>	getErrors()
String	getFormId()
String	getId()
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()
io.dialob.api.questionnaire.Questionnaire.Metadata	getQuestionnaireMetadata()
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()
protected void	initialize()
boolean	isActive()
boolean	isCompleted()
boolean	passivate()
boolean	usesLastestFormRevision()
QuestionnaireSession	withIdAndRev(String id, String rev)
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

withIdAndRev

public QuestionnaireSession withIdAndRev(String id,
 String rev)

Specified by:

withIdAndRev in interface QuestionnaireSession

builder

public static DialobQuestionnaireSession.Builder builder()

writeTo

public void writeTo(@NonNull
 com.google.protobuf.CodedOutputStream output)
             throws IOException

Throws:

IOException

dispatchActions

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

Specified by:

dispatchActions in interface QuestionnaireSession

dispatchActions

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

Specified by:

dispatchActions in interface QuestionnaireSession

getQuestionnaire

@NonNull
public io.dialob.api.questionnaire.Questionnaire getQuestionnaire()

Specified by:

getQuestionnaire in interface QuestionnaireSession

getQuestionnaireMetadata

@NonNull
public io.dialob.api.questionnaire.Questionnaire.Metadata getQuestionnaireMetadata()

Specified by:

getQuestionnaireMetadata in interface QuestionnaireSession

getRevision

@NonNull
public String getRevision()

Specified by:

getRevision in interface QuestionnaireSession

getId

public String getId()

Specified by:

getId in interface QuestionnaireSession

getRev

public String getRev()

Specified by:

getRev in interface QuestionnaireSession

getOwner

@Nullable
public String getOwner()

Specified by:

getOwner in interface QuestionnaireSession

getLastUpdate

@NonNull
public Instant getLastUpdate()

Specified by:

getLastUpdate in interface QuestionnaireSession

getActiveItem

public Optional<String> getActiveItem()

Specified by:

getActiveItem in interface QuestionnaireSession

getValueSets

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

Specified by:

getValueSets in interface QuestionnaireSession

getErrors

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

Specified by:

getErrors in interface QuestionnaireSession

getItems

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

Specified by:

getItems in interface QuestionnaireSession

getItemById

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

Specified by:

getItemById in interface QuestionnaireSession

getVisibleItems

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

Specified by:

getVisibleItems in interface QuestionnaireSession

getActiveItems

@NonNull
public Set<String> getActiveItems()

Specified by:

getActiveItems in interface QuestionnaireSession

getAnswers

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

Specified by:

getAnswers in interface QuestionnaireSession

getVariableValues

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

Specified by:

getVariableValues in interface QuestionnaireSession

buildFullForm

public void buildFullForm(@NonNull
 QuestionnaireSession.UpdatesCallback updatesCallback)

Specified by:

buildFullForm in interface QuestionnaireSession

getSessionId

public Optional<String> getSessionId()

Specified by:

getSessionId in interface QuestionnaireSession

getTenantId

public String getTenantId()

Specified by:

getTenantId in interface QuestionnaireSession

initialize

protected void initialize()

activate

public boolean activate()

Specified by:

activate in interface QuestionnaireSession

passivate

public boolean passivate()

Specified by:

passivate in interface QuestionnaireSession

isActive

public boolean isActive()

Specified by:

isActive in interface QuestionnaireSession

isCompleted

public boolean isCompleted()

Specified by:

isCompleted in interface QuestionnaireSession

usesLastestFormRevision

public boolean usesLastestFormRevision()

Specified by:

usesLastestFormRevision in interface QuestionnaireSession

getFormId

@NonNull
public String getFormId()

Specified by:

getFormId in interface QuestionnaireSession

getLocale

public Optional<Locale> getLocale()

Specified by:

getLocale in interface QuestionnaireSession

getQuestionClientVisibility

public QuestionnaireSession.QuestionClientVisibility getQuestionClientVisibility()

Specified by:

getQuestionClientVisibility in interface QuestionnaireSession

close

public void close()

Specified by:

close in interface QuestionnaireSession

getStatus

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

Specified by:

getStatus in interface QuestionnaireSession

getDialobProgram

@NonNull
public DialobProgram getDialobProgram()

getDialobSession

@NonNull
public DialobSession getDialobSession()