org.researchstack.backbone.step

Class ConsentDocumentStep

java.lang.Object

org.researchstack.backbone.step.Step

org.researchstack.backbone.step.ConsentDocumentStep

All Implemented Interfaces:

java.io.Serializable

public class ConsentDocumentStep
extends Step

This step shows an HTML version of your consent document to the user and allows them to indicate whether they agree or disagree.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConsentDocumentStep(java.lang.String identifier)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConfirmMessage() Gets the message to show the user when they are asked to confirm their agreement.
java.lang.String	getConsentHTML() Returns the HTML string of the consent document.
java.lang.Class	getStepLayoutClass() Returns the class that the ViewTaskActivity should instantiate to display this step.
int	getStepTitle() Gets the int id for the title to display in the action bar (optional).
void	setConfirmMessage(java.lang.String confirmMessage) Sets the message to show the user when they are asked to confirm their agreement.
void	setConsentHTML(java.lang.String html) Sets the HTML string that is used to show the user your consent document.

Methods inherited from class org.researchstack.backbone.step.Step

getIdentifier, getText, getTitle, isOptional, setOptional, setStepLayoutClass, setStepTitle, setText, setTitle

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsentDocumentStep

public ConsentDocumentStep(java.lang.String identifier)

Method Detail

getStepTitle

public int getStepTitle()

Description copied from class: Step

Gets the int id for the title to display in the action bar (optional).

Overrides:

getStepTitle in class Step

Returns:

the id for the title to display in the action bar

getStepLayoutClass

public java.lang.Class getStepLayoutClass()

Description copied from class: Step

Returns the class that the ViewTaskActivity should instantiate to display this step.

This method is used within the framework so that steps can define their step view controller pairing.

Outside the framework, developers should instantiate the required view controller in their ViewTaskActivity delegate to override the ViewTaskActivity's default.

Overrides:

getStepLayoutClass in class Step

Returns:

the class of the StepLayout for this step

getConsentHTML

public java.lang.String getConsentHTML()

Returns the HTML string of the consent document.

Returns:

the string representation of the entire consent HTML document

setConsentHTML

public void setConsentHTML(java.lang.String html)

Sets the HTML string that is used to show the user your consent document.

Parameters:

html - a string representation of the entire consent HTML document

getConfirmMessage

public java.lang.String getConfirmMessage()

Gets the message to show the user when they are asked to confirm their agreement.

Returns:

the string to show the user during confirmation

setConfirmMessage

public void setConfirmMessage(java.lang.String confirmMessage)

Sets the message to show the user when they are asked to confirm their agreement.

Parameters:

confirmMessage - the string to show the user during confirmation