Class ElicitationTask


  • public class ElicitationTask
    extends Object
    An elicitation task.
    Author:
    Robert Fromont robert@fromont.nz
    • Constructor Detail

      • ElicitationTask

        public ElicitationTask()
        Default constructor.
      • ElicitationTask

        public ElicitationTask​(javax.json.JsonObject json)
        Constructor from JSON.
        Parameters:
        json - A JSON representation of the object to construct.
    • Method Detail

      • getTaskId

        public int getTaskId()
        Getter for taskId: ID of the task.
        Returns:
        ID of the task.
      • setTaskId

        public ElicitationTask setTaskId​(int newTaskId)
        Setter for taskId: ID of the task.
        Parameters:
        newTaskId - ID of the task.
      • getTaskName

        public String getTaskName()
        Getter for taskName: Name of the task
        Returns:
        Name of the task
      • setTaskName

        public ElicitationTask setTaskName​(String newTaskName)
        Setter for taskName: Name of the task
        Parameters:
        newTaskName - Name of the task
      • getDescription

        public String getDescription()
        Getter for description: Description of the task.
        Returns:
        Description of the task.
      • setDescription

        public ElicitationTask setDescription​(String newDescription)
        Setter for description: Description of the task.
        Parameters:
        newDescription - Description of the task.
      • getCorpusName

        public String getCorpusName()
        Getter for corpusName: 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 for corpusName: 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 for transcriptType: The transcript type for elicited transcripts.
        Returns:
        The transcript type for elicited transcripts.
      • setTranscriptType

        public ElicitationTask setTranscriptType​(String newTranscriptType)
        Setter for transcriptType: The transcript type for elicited transcripts.
        Parameters:
        newTranscriptType - The transcript type for elicited transcripts.
      • getPreamble

        public String getPreamble()
        Getter for preamble: 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 for preamble: 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 for consent: 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 for consent: 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 for endUrl: 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 for endUrl: 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.