Package org.jppf.job

Class JobInformation

java.lang.Object
org.jppf.job.JobInformation
All Implemented Interfaces:
Serializable
public class JobInformation extends Object implements Serializable
Instances of this class provide information about the state of a job being processed by a driver.
Author:
Laurent Cohen
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    JobInformation()
    Initialize this object.
    JobInformation(String jobUuid, String jobId, int taskCount, int initialTaskCount, int priority, boolean suspended, boolean pending)
    Initialize this object with the specified parameters.
    JobInformation(TaskBundle bundle)
    Initialize this object with the specified parameters.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getInitialTaskCount()
    Get the initial task count of the job, that is, the number of tasks it contained when it was received by the driver.
    String
    getJobName()
    Get the user-defined name for the job.
    String
    getJobUuid()
    Get the unique identifier for the job.
    int
    getMaxNodes()
    Get the maximum number of nodes this job can run on.
    int
    getPriority()
    Get the priority of the job.
    int
    getTaskCount()
    Get the current number of tasks in the job.
    boolean
    isPending()
    Get the pending state of the job.
    boolean
    isSuspended()
    Determine whether the job is in suspended state.
    void
    setInitialTaskCount(int initialTaskCount)
    Deprecated.
    the field is initialized in a constructor, this setter is never used in JPPF code and should not be used in client code.
    void
    setJobName(String name)
    Deprecated.
    the field is initialized in a constructor, this setter is never used in JPPF code and should not be used in client code.
    void
    setJobUuid(String jobUuid)
    Deprecated.
    the field is initialized in a constructor, this setter is never used in JPPF code and should not be used in client code.
    void
    setMaxNodes(int maxNodes)
    Get the maximum number of nodes this job can run on.
    void
    setPending(boolean pending)
    Deprecated.
    the field is initialized in a constructor, this setter is never used in JPPF code and should not be used in client code.
    void
    setPriority(int priority)
    Deprecated.
    the field is initialized in a constructor, this setter is never used in JPPF code and should not be used in client code.
    void
    setSuspended(boolean suspended)
    Deprecated.
    the field is initialized in a constructor, this setter is never used in JPPF code and should not be used in client code.
    void
    setTaskCount(int taskCount)
    Deprecated.
    the field is initialized in a constructor, this setter is never used in JPPF code and should not be used in client code.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • JobInformation

      public JobInformation()
      Initialize this object.

    • JobInformation

      public JobInformation(TaskBundle bundle)
      Initialize this object with the specified parameters.
      Parameters:
      bundle - the task bundle from which to get the job information.

    • JobInformation

      public JobInformation(String jobUuid, String jobId, int taskCount, int initialTaskCount, int priority, boolean suspended, boolean pending)
      Initialize this object with the specified parameters.
      Parameters:
      jobUuid - the universal unique id of this job.
      jobId - the user-defined id of this job.
      taskCount - the number of tasks in this job.
      initialTaskCount - the initial number of tasks in the job submitted by the JPPF client.
      priority - the priority of this job.
      suspended - determines whether the job is in suspended state.
      pending - determines whether the job is waiting to reach its scheduled execution date.

  • Method Details

    • getJobName

      public String getJobName()
      Get the user-defined name for the job.
      Returns:
      the job name as a string.

    • setJobName

      @Deprecated public void setJobName(String name)
      Deprecated.
      the field is initialized in a constructor, this setter is never used in JPPF code and should not be used in client code.
      Set the user-defined name for the job.
      Parameters:
      name - the name as a string.

    • getTaskCount

      public int getTaskCount()
      Get the current number of tasks in the job.
      Returns:
      the number of tasks as an int.

    • setTaskCount

      @Deprecated public void setTaskCount(int taskCount)
      Deprecated.
      the field is initialized in a constructor, this setter is never used in JPPF code and should not be used in client code.
      Set the current number of tasks in the job.
      Parameters:
      taskCount - the number of tasks as an int.

    • getPriority

      public int getPriority()
      Get the priority of the job.
      Returns:
      the priority as an int.

    • setPriority

      @Deprecated public void setPriority(int priority)
      Deprecated.
      the field is initialized in a constructor, this setter is never used in JPPF code and should not be used in client code.
      Set the priority of the job.
      Parameters:
      priority - the priority as an int.

    • getInitialTaskCount

      public int getInitialTaskCount()
      Get the initial task count of the job, that is, the number of tasks it contained when it was received by the driver.
      Returns:
      the task count as an int.

    • setInitialTaskCount

      @Deprecated public void setInitialTaskCount(int initialTaskCount)
      Deprecated.
      the field is initialized in a constructor, this setter is never used in JPPF code and should not be used in client code.
      Set the initial task count of the job.
      Parameters:
      initialTaskCount - the task count as an int.

    • isSuspended

      public boolean isSuspended()
      Determine whether the job is in suspended state.
      Returns:
      true if the job is suspended, false otherwise.

    • setSuspended

      @Deprecated public void setSuspended(boolean suspended)
      Deprecated.
      the field is initialized in a constructor, this setter is never used in JPPF code and should not be used in client code.
      Specify whether the job is in suspended state.
      Parameters:
      suspended - true if the job is suspended, false otherwise.

    • getMaxNodes

      public int getMaxNodes()
      Get the maximum number of nodes this job can run on.
      Returns:
      the number of nodes as an int value.

    • setMaxNodes

      public void setMaxNodes(int maxNodes)
      Get the maximum number of nodes this job can run on.
      Parameters:
      maxNodes - the number of nodes as an int value.

    • isPending

      public boolean isPending()
      Get the pending state of the job. A job is pending if its scheduled execution date/time has not yet been reached.
      Returns:
      determines whether the job is waiting to reach its scheduled execution date.

    • setPending

      @Deprecated public void setPending(boolean pending)
      Deprecated.
      the field is initialized in a constructor, this setter is never used in JPPF code and should not be used in client code.
      Set the pending state of the job.
      Parameters:
      pending - specifies whether the job is waiting to reach its scheduled execution date.

    • getJobUuid

      public String getJobUuid()
      Get the unique identifier for the job.
      Returns:
      the uuid as a string.

    • setJobUuid

      @Deprecated public void setJobUuid(String jobUuid)
      Deprecated.
      the field is initialized in a constructor, this setter is never used in JPPF code and should not be used in client code.
      Set the unique identifier for the job.
      Parameters:
      jobUuid - the uuid as a string.

    • toString

      public String toString()
      Overrides:
      toString in class Object