uk.org.ogsadai.engine
Class Status

java.lang.Object
  |
  +--uk.org.ogsadai.engine.Status

public final class Status

extends java.lang.Object

Class representing various status of a request as it is processed by the engine.

Author:

The OGSA-DAI Team

Field Summary

static Status	COMPLETED Processing of the request has completed
private static java.lang.String	COPYRIGHT_NOTICE Copyright statement
static Status	ERROR Processing of the request has encountered an error
private java.lang.String	mText The string representation of the status.
static Status	PROCESSING Processing of the request is underway
static Status	TERMINATED Processing of the request has been terminated before completion
static Status	UNSTARTED Processing of the request has not started

Constructor Summary

private

Status(java.lang.String text) Creates a new object.

Method Summary

boolean	isFinished() Returns flag indicating whether status indicates a finished state.
boolean	isStopped() Returns flag indicating whether status indicates a stopped state.
boolean	isUnfinished() Returns flag indicating whether status indicates an unfinished state.
boolean	isUnstarted() Returns flag indicating whether status indicates an unstarted state.
java.lang.String	toString() Returns status.

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT_NOTICE

private static final java.lang.String COPYRIGHT_NOTICE

Copyright statement

See Also:

Constant Field Values

UNSTARTED

public static final Status UNSTARTED

Processing of the request has not started

PROCESSING

public static final Status PROCESSING

Processing of the request is underway

COMPLETED

public static final Status COMPLETED

Processing of the request has completed

ERROR

public static final Status ERROR

Processing of the request has encountered an error

TERMINATED

public static final Status TERMINATED

Processing of the request has been terminated before completion

mText

private final java.lang.String mText

The string representation of the status.

Constructor Detail

Status

private Status(java.lang.String text)

Creates a new object.

Parameters:

text - Status value as a string.

Method Detail

toString

public java.lang.String toString()

Returns status.

Overrides:

toString in class java.lang.Object

Returns:

status as a java.lang.String.

isStopped

public boolean isStopped()

Returns flag indicating whether status indicates a stopped state.

Returns:

true if the status indicates a stopped state, where a stopped state equals Status.ERROR or Status.TERMINATED.

isFinished

public boolean isFinished()

Returns flag indicating whether status indicates a finished state.

Returns:

true if the status indicates a finished state, where a finished state equals Status.COMPLETE, Status.ERROR or Status.TERMINATED.

isUnfinished

public boolean isUnfinished()

Returns flag indicating whether status indicates an unfinished state.

Returns:

true if the status indicates an unfinished state, where an unfinished state equals Status.UNSTARTED or Status.PROCESSING.

isUnstarted

public boolean isUnstarted()

Returns flag indicating whether status indicates an unstarted state.

Returns:

true if the status indicates an unstarted state, where an unstarted state equals Status.UNSTARTED.