org.researchstack.backbone.model

Enum ConsentSection.Type

java.lang.Object

java.lang.Enum<ConsentSection.Type>

org.researchstack.backbone.model.ConsentSection.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ConsentSection.Type>

Enclosing class:

ConsentSection

public static enum ConsentSection.Type
extends java.lang.Enum<ConsentSection.Type>
implements java.io.Serializable

Enum Constant Summary

Enum Constants

Enum Constant and Description
Custom A custom section.
DataGathering A section informing the user that sensor data will be collected.
DataUse A section describing how the collected data will be used.
OnlyInDocument Document-only sections.
Overview Overview of the informed consent process.
Privacy A section describing the privacy policies for the study.
StudySurvey A section describing survey use in the study.
StudyTasks A section describing active task use in the study.
TimeCommitment A section describing how much time is required for the study.
Withdrawing A section describing how to withdraw from the study.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getImageName()
int	getMoreInfoResId()
int	getTitleResId()
static ConsentSection.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ConsentSection.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Overview

public static final ConsentSection.Type Overview

Overview of the informed consent process.

This content can inform the user of what to expect during the process, and provide general background information on the purpose of the study.

DataGathering

public static final ConsentSection.Type DataGathering

A section informing the user that sensor data will be collected.

This content can identify which sensors will be used, for how long, and for what purpose.

Privacy

public static final ConsentSection.Type Privacy

A section describing the privacy policies for the study.

This content can describe how data is protected, the processes used to sanitize the collected data or make it anonymous, and address the risks

involved.

DataUse

public static final ConsentSection.Type DataUse

A section describing how the collected data will be used.

This content can include details about those who will have access to the data, the types of analysis that will be performed, and the degree of control the participant may have over the data after it is collected.

TimeCommitment

public static final ConsentSection.Type TimeCommitment

A section describing how much time is required for the study.

This content can help users understand what to expect as they participate in the study.

StudyTasks

public static final ConsentSection.Type StudyTasks

A section describing active task use in the study.

This content can describe what types of tasks need to be performed, how often, and for what purpose. Any risks that are involved can also be communicated in this section.

StudySurvey

public static final ConsentSection.Type StudySurvey

A section describing survey use in the study.

This content can explain how survey data will be collected, for what purpose, and make it clear to what extent participation is optional.

Withdrawing

public static final ConsentSection.Type Withdrawing

A section describing how to withdraw from the study.

This section can describe the policies that govern the collected data if the user decides to withdraw.

Custom

public static final ConsentSection.Type Custom

A custom section.

Custom sections don't have a predefined title, summary, content, image, or animation. A consent document may have as many or as few custom sections as needed.

OnlyInDocument

public static final ConsentSection.Type OnlyInDocument

Document-only sections.

Document-only sections are ignored for a visual consent step and are only displayed in a consent review step (assuming no value is provided for the htmlReviewContent property).

Method Detail

values

public static ConsentSection.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConsentSection.Type c : ConsentSection.Type.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConsentSection.Type valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getTitleResId

public int getTitleResId()

getImageName

public java.lang.String getImageName()

getMoreInfoResId

public int getMoreInfoResId()