Class CyJobStatus


public class CyJobStatus extends Object
This object stores information about the status of a CyJob, including the actual job status (CyJobStatus.Status) and any message returned from the remote execution.

Cytoscape Backwards Compatibility (API Class): We expect that this class will be used but not inherited by developers using this class. As such, we reserve the right to add methods to the class as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.

Module: jobs-api

To use this in your app, include the following dependency in your POM:

  • Field Details

  • Constructor Details

  • Method Details

    • getStatus

      public CyJobStatus.Status getStatus()
      Return the CyJobStatus.Status of the remote job
      the CyJobStatus.Status
    • getMessage

      public String getMessage()
      Return any message associated with the job status.
      a message, or null if no message was included
    • toString

      public String toString()
      Return a string including the status and the message, if any.
      toString in class Object
      a string describing the status
    • isDone

      public boolean isDone()
      Static method to determine if a job is "done", where done means that it is no longer processing for any reason.
      status - the status to check
      true if the status indicates the job is done