Class TaskStatusInfo

  • All Implemented Interfaces:
    java.io.Serializable, RevisionHandler

    public class TaskStatusInfo
    extends java.lang.Object
    implements java.io.Serializable, RevisionHandler
    A class holding information for tasks being executed on RemoteEngines. Also holds an object encapsulating any returnable result produced by the task (Note: result object must be serializable). Task objects execute methods return instances of this class. RemoteEngines also use this class for storing progress information for tasks that they execute.
    Version:
    $Revision: 1.5 $
    Author:
    Mark Hall
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      TaskStatusInfo()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getExecutionStatus()
      Get the execution status of this Task.
      java.lang.String getRevision()
      Returns the revision string.
      java.lang.String getStatusMessage()
      Get the status message.
      java.lang.Object getTaskResult()
      Get the returnable result of this task.
      void setExecutionStatus​(int newStatus)
      Set the execution status of this Task.
      void setStatusMessage​(java.lang.String newMessage)
      Set the status message.
      void setTaskResult​(java.lang.Object taskResult)
      Set the returnable result for this task..
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • TaskStatusInfo

        public TaskStatusInfo()
    • Method Detail

      • setExecutionStatus

        public void setExecutionStatus​(int newStatus)
        Set the execution status of this Task.
        Parameters:
        newStatus - the new execution status code
      • getExecutionStatus

        public int getExecutionStatus()
        Get the execution status of this Task.
        Returns:
        the execution status
      • setStatusMessage

        public void setStatusMessage​(java.lang.String newMessage)
        Set the status message.
        Parameters:
        newMessage - the new status message
      • getStatusMessage

        public java.lang.String getStatusMessage()
        Get the status message.
        Returns:
        the status message
      • setTaskResult

        public void setTaskResult​(java.lang.Object taskResult)
        Set the returnable result for this task..
        Parameters:
        taskResult - the new returnable result for the task. null if no result is returnable.
      • getTaskResult

        public java.lang.Object getTaskResult()
        Get the returnable result of this task.
        Returns:
        an object encapsulating the result of executing the task. May be null if the task has no returnable result (eg. a remote experiment task that sends its results to a data base).
      • getRevision

        public java.lang.String getRevision()
        Returns the revision string.
        Specified by:
        getRevision in interface RevisionHandler
        Returns:
        the revision