com.adobe.idp.jobmanager.common
Class JobStatus

java.lang.Object
  com.adobe.idp.jobmanager.common.JobStatus

All Implemented Interfaces:

java.io.Serializable

public class JobStatus
extends java.lang.Object
implements java.io.Serializable

Contains the status for a job in progress.

See Also:

Serialized Form

Field Summary

static short	JOB_STATUS_COMPLETE_REQUESTED Specifies that a job complete request was made.
static short	JOB_STATUS_COMPLETED Specifies the job is completed.
static short	JOB_STATUS_FAILED Specifies the job has failed.
static short	JOB_STATUS_FAILURE_REQUESTED
static short	JOB_STATUS_QUEUED Specifies the job is queued.
static short	JOB_STATUS_RESUME_REQUESTED Specifies that a job resume request was made.
static short	JOB_STATUS_RUNNING Specifies the job is running.
static short	JOB_STATUS_SUSPEND_REQUESTED Specifies the job status is completed.
static short	JOB_STATUS_SUSPENDED Specifies the job status is suspended.
static short	JOB_STATUS_TERMINATE_REQUESTED Specifies that a job terminate request was made.
static short	JOB_STATUS_TERMINATED Specifies the job has terminated.
static short	JOB_STATUS_UNKNOWN Specifies the job status is unknown.

Constructor Summary

JobStatus()
A standard constructor.

JobStatus(short statusCode)
A constructor that creates a JobStatus object based on a status code.

Method Summary

short	getStatusCode() Returns the status code associated with this object.
static java.lang.String	getStatusString(short status)
void	setStatusCode(short statusCode) For internal use only.
java.lang.String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

JOB_STATUS_UNKNOWN

public static final short JOB_STATUS_UNKNOWN

Specifies the job status is unknown.

See Also:

Constant Field Values

JOB_STATUS_QUEUED

public static final short JOB_STATUS_QUEUED

Specifies the job is queued.

See Also:

Constant Field Values

JOB_STATUS_RUNNING

public static final short JOB_STATUS_RUNNING

Specifies the job is running.

See Also:

Constant Field Values

JOB_STATUS_COMPLETED

public static final short JOB_STATUS_COMPLETED

Specifies the job is completed.

See Also:

Constant Field Values

JOB_STATUS_FAILED

public static final short JOB_STATUS_FAILED

Specifies the job has failed.

See Also:

Constant Field Values

JOB_STATUS_TERMINATED

public static final short JOB_STATUS_TERMINATED

Specifies the job has terminated.

See Also:

Constant Field Values

JOB_STATUS_SUSPENDED

public static final short JOB_STATUS_SUSPENDED

Specifies the job status is suspended.

See Also:

Constant Field Values

JOB_STATUS_COMPLETE_REQUESTED

public static final short JOB_STATUS_COMPLETE_REQUESTED

Specifies that a job complete request was made.

See Also:

Constant Field Values

JOB_STATUS_TERMINATE_REQUESTED

public static final short JOB_STATUS_TERMINATE_REQUESTED

Specifies that a job terminate request was made.

See Also:

Constant Field Values

JOB_STATUS_SUSPEND_REQUESTED

public static final short JOB_STATUS_SUSPEND_REQUESTED

Specifies the job status is completed.

See Also:

Constant Field Values

JOB_STATUS_RESUME_REQUESTED

public static final short JOB_STATUS_RESUME_REQUESTED

Specifies that a job resume request was made.

See Also:

Constant Field Values

JOB_STATUS_FAILURE_REQUESTED

public static final short JOB_STATUS_FAILURE_REQUESTED

See Also:

Constant Field Values

Constructor Detail

JobStatus

public JobStatus()

A standard constructor.

JobStatus

public JobStatus(short statusCode)

A constructor that creates a JobStatus object based on a status code.

Parameters:

statusCode - A status code value.

Method Detail

getStatusCode

public short getStatusCode()

Returns the status code associated with this object. The following specifies status code values:

• 0 - JOB_STATUS_UNKNOWN
• 1 - JOB_STATUS_QUEUED
• 2 - JOB_STATUS_RUNNING
• 3 - JOB_STATUS_COMPLETED
• 4 - JOB_STATUS_FAILED
• 5 - JOB_STATUS_TERMINATED
• 6 - JOB_STATUS_SUSPENDED
• 7 - JOB_STATUS_COMPLETE_REQUESTED
• 8 - JOB_STATUS_TERMINATE_REQUESTED
• 9 - JOB_STATUS_SUSPEND_REQUESTED
• 0 - JOB_STATUS_UNKNOWN
• 10 - JOB_STATUS_RESUME_REQUESTED

Returns:

A status code value.

setStatusCode

public void setStatusCode(short statusCode)

For internal use only.

getStatusString

public static java.lang.String getStatusString(short status)

toString

public java.lang.String toString()

Returns a string representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.