eu.geclipse.core.model
Interface IGridJobStatus

All Known Implementing Classes:

GridJobStatus

public interface IGridJobStatus

This interface defines some informational fields related to the status of jobs in the Grid.

Field Summary

static int	_ALL Shortcut for all known statuses.
static int	ABORTED Status of the job which was finished unsuccessfully
static int	DONE Status of the job which was finished successfully
static int	PURGED Status of the job for which status information is no longer available. e.g.
static int	RUNNING Status of the job which is actually running
static int	SUBMITTED Status of the job which was submitted and is not scheduled by RB yet.
static int	UNDEF Status of the job cannot be determined.
static int	UNKNOWN Status for job which real status cannot be retrieved now
static int	WAITING Status of the job which was scheduled by RB and is sent to its destination, but computation was not started yet.

Method Summary

boolean	canChange() Return true if the status of the job can be changed in the future yet.
java.util.Date	getLastUpdateTime() Returns the date of last status update.
java.lang.String	getName() Returns the name of the status.
java.lang.String	getReason() Return the explanation why the job is in the specific state.
int	getType() Returns the type of the status.
boolean	isSuccessful() Return true if the job was finished successfully.

Field Detail

SUBMITTED

static final int SUBMITTED

Status of the job which was submitted and is not scheduled by RB yet.

See Also:

Constant Field Values

WAITING

static final int WAITING

Status of the job which was scheduled by RB and is sent to its destination, but computation was not started yet.

See Also:

Constant Field Values

RUNNING

static final int RUNNING

Status of the job which is actually running

See Also:

Constant Field Values

DONE

static final int DONE

Status of the job which was finished successfully

See Also:

Constant Field Values

ABORTED

static final int ABORTED

Status of the job which was finished unsuccessfully

See Also:

Constant Field Values

PURGED

static final int PURGED

Status of the job for which status information is no longer available. e.g. job information was removed from RB. The difference between UNKNOWN and PURGED is that UNKNOWN can be changed in the future to the real status and PURGED is a final status.

See Also:

Constant Field Values

UNDEF

static final int UNDEF

Status of the job cannot be determined.

The difference between UNDEF and UNKNOWN is that UNKNOWN is a temporary state (e.g. because some network problem) and UNDEF is more permanent state (e.g. status cannot be retrieved because there is no access to status service like no appropriate plugin is available) Job with status UNKNOWN will be queried again during the session, job wit status UNDEF will not. UNDEF job existing in the workspace will be queried for update when gEclipse starts

See Also:

Constant Field Values

UNKNOWN

static final int UNKNOWN

Status for job which real status cannot be retrieved now

See Also:

Constant Field Values

_ALL

static final int _ALL

Shortcut for all known statuses.

See Also:

Constant Field Values

Method Detail

canChange

boolean canChange()

Return true if the status of the job can be changed in the future yet. Return false if status if final (e.g. Aborted, Done, Failed)

To check if job succeeded use method isSuccessfull

Returns:

true if status can change yet

isSuccessful

boolean isSuccessful()

Return true if the job was finished successfully. This method should be called only if method canChange() returns true.

For statuses which are not final the behaviour of is Successfull() method is undefined.

To check if job succeeded use method isSuccessfull()

Returns:

true if the job was finished successfully

getName

java.lang.String getName()

Returns the name of the status. This can be any string and is not interpreted. It will be just printed in the status window to show the status to the user. To check the meaning of the status use methods canChange(), isSuccessful() or middleware specific implementation.

Returns:

Name of the status

getType

int getType()

Returns the type of the status. This is integer value and defines the meaning of the status. This value will be used for filtering job list to those with a given status type. Type can be also used by user interface to mark jobs belonging to the same type with the same graphical elements (e.g. icons, colours)

Returns:

Name of the status

getLastUpdateTime

java.util.Date getLastUpdateTime()

Returns the date of last status update. It should be the time of last contact with middleware service and not the time of last status change.

Returns:

time of last update

getReason

java.lang.String getReason()

Return the explanation why the job is in the specific state. Can give more detailed information than just status name.

Returns:

String with explanation