org.eclipse.ptp.core.jobs
Interface IJobStatus

All Known Subinterfaces:

IPJobStatus

public interface IJobStatus

Interface for obtaining status information about a job. Instances are normally obtained via the JobManager class.

Since:

6.0

Field Summary

static String	CANCELED Job was canceled/aborted by user before finishing.
static String	COMPLETED Job has completed execution.
static String	FAILED Job exited abnormally before finishing.
static String	JOB_OUTERR_READY Stdout and/or stderr have been copied to a user-determined location.
static String	QUEUED_ACTIVE Job is queued and waiting to be scheduled.
static String	RUNNING Job has been scheduled and is running.
static String	SUBMITTED Job has been submitted but has not yet begun execution
static String	SUSPENDED Running job has been suspended.
static String	SYSTEM_ON_HOLD Job has been placed on hold by the system or the administrator.
static String	SYSTEM_SUSPENDED Running job has been suspended by the system or administrator.
static String	UNDETERMINED Job status cannot be determined
static String	USER_ON_HOLD Job has been placed on hold by a user.
static String	USER_SUSPENDED Running job has been suspended by a user.
static String	USER_SYSTEM_ON_HOLD Job has been placed on hold by both the system or administrator and a user.
static String	USER_SYSTEM_SUSPENDED Running job has been suspended by both the system or administrator and a user.

Method Summary

String	getControlId() Get the ID of the controller used to launch the job
String	getErrorPath()
String	getJobId() Get the job ID of the job this status is for
String	getLaunchMode()
String	getOutputPath()
String	getOwner() Get job owner if available
String	getQueueName() Get the queue name for the job if available
String	getState() Get job state.
String	getStateDetail() Get job state detail.
IStreamsProxy	getStreamsProxy() Get streams proxy for job.
boolean	isInteractive()

Field Detail

UNDETERMINED

static final String UNDETERMINED

Job status cannot be determined

See Also:

Constant Field Values

SUBMITTED

static final String SUBMITTED

Job has been submitted but has not yet begun execution

See Also:

Constant Field Values

RUNNING

static final String RUNNING

Job has been scheduled and is running.

See Also:

Constant Field Values

SUSPENDED

static final String SUSPENDED

Running job has been suspended.

See Also:

Constant Field Values

COMPLETED

static final String COMPLETED

Job has completed execution.

See Also:

Constant Field Values

QUEUED_ACTIVE

static final String QUEUED_ACTIVE

Job is queued and waiting to be scheduled. Jobs in this state have not yet run and are considered "SUBMITTED".

See Also:

Constant Field Values

SYSTEM_ON_HOLD

static final String SYSTEM_ON_HOLD

Job has been placed on hold by the system or the administrator. Jobs in this state have not yet run and are considered "SUBMITTED".

See Also:

Constant Field Values

USER_ON_HOLD

static final String USER_ON_HOLD

Job has been placed on hold by a user. Jobs in this state have not yet run and are considered "SUBMITTED".

See Also:

Constant Field Values

USER_SYSTEM_ON_HOLD

static final String USER_SYSTEM_ON_HOLD

Job has been placed on hold by both the system or administrator and a user. Jobs in this state have not yet run and are considered "SUBMITTED".

See Also:

Constant Field Values

SYSTEM_SUSPENDED

static final String SYSTEM_SUSPENDED

Running job has been suspended by the system or administrator. Jobs in this state have begun execution and are considered "SUSPENDED".

See Also:

Constant Field Values

USER_SUSPENDED

static final String USER_SUSPENDED

Running job has been suspended by a user. Jobs in this state have begun execution and are considered "SUSPENDED".

See Also:

Constant Field Values

USER_SYSTEM_SUSPENDED

static final String USER_SYSTEM_SUSPENDED

Running job has been suspended by both the system or administrator and a user. Jobs in this state have begun execution and are considered "SUSPENDED".

See Also:

Constant Field Values

FAILED

static final String FAILED

Job exited abnormally before finishing. Jobs in this state have completed execution and are considered "COMPLETED".

See Also:

Constant Field Values

CANCELED

static final String CANCELED

Job was canceled/aborted by user before finishing. Jobs in this state have completed execution and are considered "COMPLETED".

See Also:

Constant Field Values

JOB_OUTERR_READY

static final String JOB_OUTERR_READY

Stdout and/or stderr have been copied to a user-determined location. Jobs in this state have completed execution and are considered "COMPLETED".

See Also:

Constant Field Values

Method Detail

getControlId

String getControlId()

Get the ID of the controller used to launch the job

Returns:

control ID

Since:

6.0

getErrorPath

String getErrorPath()

Returns:

path to remote file

getJobId

String getJobId()

Get the job ID of the job this status is for

Returns:

job ID

getLaunchMode

String getLaunchMode()

Since:

7.0

getOutputPath

String getOutputPath()

Returns:

path to remote file

getOwner

String getOwner()

Get job owner if available

Returns:

job owner or null if not available

getQueueName

String getQueueName()

Get the queue name for the job if available

Returns:

queue name or null if not available

getState

String getState()

Get job state. This is the primary state of the job, and is one of UNDETERMINED, SUBMITTED, RUNNING, SUSPENDED or COMPLETED. Note that UNDETERMINED will only be returned if no other valid job state has been reach. Implementations MUST return the last valid job state if one is available.

Returns:

state of the job

getStateDetail

String getStateDetail()

Get job state detail. This either returns the same state as getState() or provides additional detail on the state of the job.

Returns:

detailed state of the job

getStreamsProxy

IStreamsProxy getStreamsProxy()

Get streams proxy for job. Only available if job is in RUNNING state.

Returns:

isInteractive

boolean isInteractive()

Returns:

if the batch states do not apply to this job.