Package nzilbb.labbcat.model
Class ElicitationTask
- java.lang.Object
-
- nzilbb.labbcat.model.ElicitationTask
-
public class ElicitationTask extends Object
An elicitation task.- Author:
- Robert Fromont robert@fromont.nz
-
-
Constructor Summary
Constructors Constructor Description ElicitationTask()Default constructor.ElicitationTask(javax.json.JsonObject json)Constructor from JSON.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetConsent()Getter forconsent: Optionally, the HTML-encoded consent form the participant 'signs' before starting the task.StringgetCorpusName()Getter forcorpusName: The corpus into which task transcripts/recordings will be uploaded.StringgetDescription()Getter fordescription: Description of the task.StringgetEndUrl()Getter forendUrl: Optionally, the URL for redirecting the participant to after finishing the task.StringgetPreamble()Getter forpreamble: The HTML-encoded text displayed to the participant before starting the task.intgetTaskId()Getter fortaskId: ID of the task.StringgetTaskName()Getter fortaskName: Name of the taskStringgetTranscriptType()Getter fortranscriptType: The transcript type for elicited transcripts.ElicitationTasksetConsent(String newConsent)Setter forconsent: Optionally, the HTML-encoded consent form the participant 'signs' before starting the task.ElicitationTasksetCorpusName(String newCorpusName)Setter forcorpusName: The corpus into which task transcripts/recordings will be uploaded.ElicitationTasksetDescription(String newDescription)Setter fordescription: Description of the task.ElicitationTasksetEndUrl(String newEndUrl)Setter forendUrl: Optionally, the URL for redirecting the participant to after finishing the task.ElicitationTasksetPreamble(String newPreamble)Setter forpreamble: The HTML-encoded text displayed to the participant before starting the task.ElicitationTasksetTaskId(int newTaskId)Setter fortaskId: ID of the task.ElicitationTasksetTaskName(String newTaskName)Setter fortaskName: Name of the taskElicitationTasksetTranscriptType(String newTranscriptType)Setter fortranscriptType: The transcript type for elicited transcripts.javax.json.JsonObjecttoJson()Serializes the object to JSON.
-
-
-
Method Detail
-
getTaskId
public int getTaskId()
Getter fortaskId: ID of the task.- Returns:
- ID of the task.
-
setTaskId
public ElicitationTask setTaskId(int newTaskId)
Setter fortaskId: ID of the task.- Parameters:
newTaskId- ID of the task.
-
getTaskName
public String getTaskName()
Getter fortaskName: Name of the task- Returns:
- Name of the task
-
setTaskName
public ElicitationTask setTaskName(String newTaskName)
Setter fortaskName: Name of the task- Parameters:
newTaskName- Name of the task
-
getDescription
public String getDescription()
Getter fordescription: Description of the task.- Returns:
- Description of the task.
-
setDescription
public ElicitationTask setDescription(String newDescription)
Setter fordescription: Description of the task.- Parameters:
newDescription- Description of the task.
-
getCorpusName
public String getCorpusName()
Getter forcorpusName: The corpus into which task transcripts/recordings will be uploaded.- Returns:
- The corpus into which task transcripts/recordings will be uploaded.
-
setCorpusName
public ElicitationTask setCorpusName(String newCorpusName)
Setter forcorpusName: The corpus into which task transcripts/recordings will be uploaded.- Parameters:
newCorpusName- The corpus into which task transcripts/recordings will be uploaded.
-
getTranscriptType
public String getTranscriptType()
Getter fortranscriptType: The transcript type for elicited transcripts.- Returns:
- The transcript type for elicited transcripts.
-
setTranscriptType
public ElicitationTask setTranscriptType(String newTranscriptType)
Setter fortranscriptType: The transcript type for elicited transcripts.- Parameters:
newTranscriptType- The transcript type for elicited transcripts.
-
getPreamble
public String getPreamble()
Getter forpreamble: The HTML-encoded text displayed to the participant before starting the task.- Returns:
- The HTML-encoded text displayed to the participant before starting the task.
-
setPreamble
public ElicitationTask setPreamble(String newPreamble)
Setter forpreamble: The HTML-encoded text displayed to the participant before starting the task.- Parameters:
newPreamble- The HTML-encoded text displayed to the participant before starting the task.
-
getConsent
public String getConsent()
Getter forconsent: Optionally, the HTML-encoded consent form the participant 'signs' before starting the task.- Returns:
- Optionally, the HTML-encoded consent form the participant 'signs' before starting the task.
-
setConsent
public ElicitationTask setConsent(String newConsent)
Setter forconsent: Optionally, the HTML-encoded consent form the participant 'signs' before starting the task.- Parameters:
newConsent- Optionally, the HTML-encoded consent form the participant 'signs' before starting the task.
-
getEndUrl
public String getEndUrl()
Getter forendUrl: Optionally, the URL for redirecting the participant to after finishing the task.- Returns:
- Optionally, the URL for redirecting the participant to after finishing the task.
-
setEndUrl
public ElicitationTask setEndUrl(String newEndUrl)
Setter forendUrl: Optionally, the URL for redirecting the participant to after finishing the task.- Parameters:
newEndUrl- Optionally, the URL for redirecting the participant to after finishing the task.
-
toJson
public javax.json.JsonObject toJson()
Serializes the object to JSON.- Returns:
- A JSON serialization of the object.
-
-