Class GetComments

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

public class GetComments extends XMLRequest implements Iterable<GetComments.Comment>
Returns the comments of a task.
  • Constructor Details

    • GetComments

      public GetComments(int runID)
      Returns all comments for the specified task.
      Parameters:
      runID - runID of the task
  • Method Details

    • 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
    • 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
    • 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
    • getComments

      public String getComments()
      Returns the comments as String. The returned String contains multiple lines. If the runID is valid but no comment has been set for this task the return value is an empty String.
      Returns:
      comments or null in case of an error.
    • iterator

      public Iterator<GetComments.Comment> iterator()
      Specified by:
      iterator in interface Iterable<GetComments.Comment>
    • isAllowedInClientZero

      protected boolean isAllowedInClientZero()
      Description copied from class: XMLRequest
      This method is used internally. Tests if this XMLRequest is allowed in client 0. The default implementation returns false, subclasses may override.
      Overrides:
      isAllowedInClientZero in class XMLRequest
      Returns:
      true if this request is allowed in client 0, false otherwise
    • size

      public int size()
      Returns the number of comments.
      Returns:
      Number of comments