ca.eandb.jdcp.remote

Class JobStatus

java.lang.Object

ca.eandb.jdcp.remote.JobStatus

All Implemented Interfaces:

Serializable

public final class JobStatus
extends Object
implements Serializable

Represents the status of a job hosted on the server.

Author:

Brad Kimmel

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobStatus(UUID jobId, String description, JobState state, double progress, String status) Creates a new JobStatus with no event ID.
JobStatus(UUID jobId, String description, JobState state, String status) Creates a new JobStatus with no event ID and indeterminant progress.

Method Summary

Modifier and Type	Method and Description
JobStatus	asCancelled() Creates a copy of this JobStatus with the state set to JobState.CANCELLED.
JobStatus	asComplete() Creates a copy of this JobStatus with the state set to JobState.COMPLETE.
String	getDescription() Gets a description of the job.
long	getEventId() Gets the event ID.
UUID	getJobId() Gets the UUID that identifies the job.
double	getProgress() Gets a value indicating the progress of the job (complete = 1.0).
JobState	getState() Gets the current state of the job (new, running, complete, etc.).
String	getStatus() Gets a description of the status of the job.
boolean	isCancelled() Gets a value indicating if the job has been cancelled.
boolean	isComplete() Gets a value indicating if the job is complete.
boolean	isProgressIndeterminant() Gets a value indicating if the progress of the job is indeterminant.
JobStatus	withIndeterminantProgress() Creates a copy of this JobStatus with the progress set to an indeterminant value (Double.NaN).
JobStatus	withNewEventId() Creates a copy of this JobStatus with an auto-generated event ID.
JobStatus	withProgress(double newProgress) Creates a copy of this JobStatus with the progress set to the specified value.
JobStatus	withStatus(String newStatus) Creates a copy of this JobStatus with the status string set to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobStatus

public JobStatus(UUID jobId,
                 String description,
                 JobState state,
                 double progress,
                 String status)

Creates a new JobStatus with no event ID.

Parameters:

jobId - The UUID identifying the job.

description - A description of the job.

state - The current state of the job (new, running, complete, etc).

progress - The progress toward completion (complete = 1.0). If equal to Double.NaN, the progress is indeterminant.

status - A description of the current status of the job.

JobStatus

public JobStatus(UUID jobId,
                 String description,
                 JobState state,
                 String status)

Creates a new JobStatus with no event ID and indeterminant progress.

Parameters:

jobId - The UUID identifying the job.

description - A description of the job.

state - The current state of the job (new, running, complete, etc).

status - A description of the current status of the job.

Method Detail

withProgress

public JobStatus withProgress(double newProgress)

Creates a copy of this JobStatus with the progress set to the specified value.

Parameters:

newProgress - The progress toward completion (complete = 1.0). If equal to Double.NaN, the progress is indeterminant.

Returns:

A copy of this JobStatus with the progress set to the specified value.

withStatus

public JobStatus withStatus(String newStatus)

Creates a copy of this JobStatus with the status string set to the specified value.

Parameters:

newStatus - A description of the current status of the job.

Returns:

A copy of this JobStatus with the status string set to the specified value.

asComplete

public JobStatus asComplete()

Creates a copy of this JobStatus with the state set to JobState.COMPLETE.

Returns:

A copy of this JobStatus with the state set to JobState.COMPLETE.

asCancelled

public JobStatus asCancelled()

Creates a copy of this JobStatus with the state set to JobState.CANCELLED.

Returns:

A copy of this JobStatus with the state set to JobState.CANCELLED.

withIndeterminantProgress

public JobStatus withIndeterminantProgress()

Creates a copy of this JobStatus with the progress set to an indeterminant value (Double.NaN).

Returns:

A copy of this JobStatus with the progress set to indeterminant.

withNewEventId

public JobStatus withNewEventId()

Creates a copy of this JobStatus with an auto-generated event ID. The event ID will be greater than any previously generated event ID.

Returns:

A copy of this JobStatus with an auto-generated event ID.

getJobId

public UUID getJobId()

Gets the UUID that identifies the job.

Returns:

The UUID that identifies the job.

getDescription

public String getDescription()

Gets a description of the job.

Returns:

A description of the job.

getState

public JobState getState()

Gets the current state of the job (new, running, complete, etc.).

Returns:

The current state of the job (new, running, complete, etc.).

isComplete

public boolean isComplete()

Gets a value indicating if the job is complete.

Returns:

A value indicating if the job is complete.

isCancelled

public boolean isCancelled()

Gets a value indicating if the job has been cancelled.

Returns:

A value indicating if the job has been cancelled.

getProgress

public double getProgress()

Gets a value indicating the progress of the job (complete = 1.0).

Returns:

A value indicating the progress of the job.

isProgressIndeterminant

public boolean isProgressIndeterminant()

Gets a value indicating if the progress of the job is indeterminant.

Returns:

A value indicating if the progress of the job is indeterminant.

getStatus

public String getStatus()

Gets a description of the status of the job.

Returns:

A description of the status of the job.

getEventId

public long getEventId()

Gets the event ID.

Returns:

The event ID.