Package org.cytoscape.jobs

Class CyJobStatus

java.lang.Object

org.cytoscape.jobs.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:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>jobs-api</artifactId>
</dependency>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CyJobStatus.Status	This enum contains the primary status returned from the remote execution.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	message
protected CyJobStatus.Status	status

Constructor Summary

Constructors

Constructor	Description
CyJobStatus(CyJobStatus.Status status, String message)

Method Summary

Modifier and Type	Method	Description
String	getMessage()	Return any message associated with the job status.
CyJobStatus.Status	getStatus()	Return the CyJobStatus.Status of the remote job
boolean	isDone()	Static method to determine if a job is "done", where done means that it is no longer processing for any reason.
String	toString()	Return a string including the status and the message, if any.

Methods inherited from class java.lang.Object

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

Field Details

status

protected CyJobStatus.Status status

message

protected String message

Constructor Details

CyJobStatus

public CyJobStatus(CyJobStatus.Status status,
 String message)

Method Details

getStatus

public CyJobStatus.Status getStatus()

Return the CyJobStatus.Status of the remote job

Returns:

the CyJobStatus.Status

getMessage

public String getMessage()

Return any message associated with the job status.

Returns:

a message, or null if no message was included

toString

public String toString()

Return a string including the status and the message, if any.

Overrides:

toString in class Object

Returns:

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.

Parameters:

status - the status to check

Returns:

true if the status indicates the job is done