Package nzilbb.labbcat.model

Class TaskStatus

java.lang.Object
nzilbb.labbcat.model.TaskStatus
public class TaskStatus extends Object
The status of a server-side task.
Author:
Robert Fromont robert@fromont.net.nz

  • Constructor Details

    • TaskStatus

      public TaskStatus()
      Default constructor.

    • TaskStatus

      public TaskStatus(javax.json.JsonObject json)
      Constructor from JSON.
      Parameters:
      json - A JSON representation of the object to construct.

  • Method Details

    • getThreadId

      public String getThreadId()
      Getter for threadId: ID of the task.
      Returns:
      ID of the task.

    • setThreadId

      public TaskStatus setThreadId(String newThreadId)
      Setter for threadId: ID of the task.
      Parameters:
      newThreadId - ID of the task.
      Returns:
      A reference to this object, so that setters can be chained.

    • getThreadName

      public String getThreadName()
      Getter for threadName: Name of the task.
      Returns:
      Name of the task.

    • setThreadName

      public TaskStatus setThreadName(String newThreadName)
      Setter for threadName: Name of the task.
      Parameters:
      newThreadName - Name of the task.
      Returns:
      A reference to this object, so that setters can be chained. x

    • getRunning

      public boolean getRunning()
      Getter for running: Whether the task is currently running (true) or complete (false).
      Returns:
      Whether the task is currently running (true) or complete (false).

    • setRunning

      public TaskStatus setRunning(boolean newRunning)
      Setter for running: Whether the task is currently running (true) or complete (false).
      Parameters:
      newRunning - Whether the task is currently running (true) or complete (false).
      Returns:
      A reference to this object, so that setters can be chained.

    • getDuration

      public int getDuration()
      Getter for duration: Duration in seconds.
      Returns:
      Duration in seconds.

    • setDuration

      public TaskStatus setDuration(int newDuration)
      Setter for duration: Duration in seconds.
      Parameters:
      newDuration - Duration in seconds.
      Returns:
      A reference to this object, so that setters can be chained.

    • getPercentComplete

      public int getPercentComplete()
      Getter for percentComplete: Percent complete.
      Returns:
      Percent complete.

    • setPercentComplete

      public TaskStatus setPercentComplete(int newPercentComplete)
      Setter for percentComplete: Percent complete.
      Parameters:
      newPercentComplete - Percent complete.
      Returns:
      A reference to this object, so that setters can be chained.

    • getStatus

      public String getStatus()
      Getter for status: Last status message.
      Returns:
      Last status message.

    • setStatus

      public TaskStatus setStatus(String newStatus)
      Setter for status: Last status message.
      Parameters:
      newStatus - Last status message.
      Returns:
      A reference to this object, so that setters can be chained.

    • getRefreshSeconds

      public int getRefreshSeconds()
      Getter for refreshSeconds: Suggested status refresh interval.
      Returns:
      Suggested status refresh interval.

    • setRefreshSeconds

      public TaskStatus setRefreshSeconds(int newRefreshSeconds)
      Setter for refreshSeconds: Suggested status refresh interval.
      Parameters:
      newRefreshSeconds - Suggested status refresh interval.
      Returns:
      A reference to this object, so that setters can be chained.

    • getResultUrl

      public String getResultUrl()
      Getter for resultUrl: URL for task results, if any.
      Returns:
      URL for task results, if any.

    • setResultUrl

      public TaskStatus setResultUrl(String newResultUrl)
      Setter for resultUrl: URL for task results, if any.
      Parameters:
      newResultUrl - URL for task results, if any.
      Returns:
      A reference to this object, so that setters can be chained.

    • getResultText

      public String getResultText()
      Getter for resultText: The label for the results.
      Returns:
      The label for the results.

    • setResultText

      public TaskStatus setResultText(String newResultText)
      Setter for resultText: The label for the results.
      Parameters:
      newResultText - The label for the results.
      Returns:
      A reference to this object, so that setters can be chained.

    • toString

      public String toString()
      Represents the object as a String, for logging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the object.