Class TaskPromptSetNames

java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.TaskPromptSetNames
All Implemented Interfaces:
Iterable<TaskPromptSetName>

public class TaskPromptSetNames extends XMLRequest implements Iterable<TaskPromptSetName>
This request reads a list of Prompt Set Objects of a specified task.
  • Constructor Details

    • TaskPromptSetNames

      public TaskPromptSetNames(int runID)
      Creates a new GetTaskPromptSetNames request.
      Parameters:
      runID - RunID of the task
  • Method Details

    • createRequest

      protected void createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo)
      Description copied from class: XMLRequest
      Creates the XML Document for the request. This method is used internally.
      Specified by:
      createRequest in class XMLRequest
      Parameters:
      doc - Document, used to create new Elements
      request - Request Element - classes append information to this request element
      sessionInfo - Information about the session
    • getSrc

      protected String getSrc()
      Description copied from class: XMLRequest
      Returns the request source. This method is used internally.
      Specified by:
      getSrc in class XMLRequest
      Returns:
      Source
    • handleContent

      protected void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
      Description copied from class: XMLRequest
      Sub classes extract the values from the XML document and provide public getter methods.
      Overrides:
      handleContent in class XMLRequest
      Parameters:
      doc - XML Document
      session - Info about the user session
    • getTimezoneText

      public String getTimezoneText()
      Returns the timezone information. This is the same text as is displayed in the User Interface.
      Returns:
      Text containing the name of the timezone
    • getRunID

      public int getRunID()
      Get RunID.
      Returns:
      RunID
    • size

      public int size()
      Returns the number of prompt elements.
      Returns:
      Number of elements
    • getPromptSets

      @Deprecated public UC4ObjectName[] getPromptSets()
      Deprecated.
      Use the iterator() method instead.
      Returns a list of PromptSet names. If there are no prompt sets an array of length 0 is returned.
      Returns:
      Name of Prompt Objects never null
    • iterator

      public Iterator<TaskPromptSetName> iterator()
      Specified by:
      iterator in interface Iterable<TaskPromptSetName>