wt.queue
Class StatusInfo

java.lang.Object
  wt.queue.StatusInfo

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Serializable

Direct Known Subclasses:

SchedStatusInfo

public class StatusInfo

extends Object

implements ObjectMappable, Externalizable

Represents the status of the queue entry. Contains a code (READY, COMPLETED, FAILED, EXECUTING, SUSPENDED and NOTIFY) and an (optional) message.

Use the newStatusInfo static factory method(s), not the StatusInfo constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private String	code
static String	CODE Label for the attribute; Stores the queue entry status code.
private static int	CODE_UPPER_LIMIT
static String	COMPLETED Constant indicating that the entry has been processed successfully.
static String	EXECUTING Constant to indicate that the entry is being executed.
static long	EXTERNALIZATION_VERSION_UID
static String	FAILED Constant indicating that the entry has been processed unsuccessfully.
private String	message
static String	MESSAGE Label for the attribute; Contains message associated with the execution of the entry.
private static int	MESSAGE_UPPER_LIMIT
static String	NOTIFY Indicates that an entry has failed after repeated attempts and that an administrator should be notified.
protected static long	OLD_FORMAT_VERSION_UID
static String	READY Constant indicating that the entry is ready to be executed.
static String	RESCHEDULE Used to indicate the entry should be rescheduled Supported API: false
static String	RESCHEDULE_TIME Label for the attribute.
private Timestamp	rescheduleTime
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	SEVERE Denotes that the QueueEntry is failed due to InvocationTargetException or Exception Supported API: false
static String	SUSPENDED State of an entry in which it is not chosen for processing.

Constructor Summary

StatusInfo()

Method Summary

ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getCode() Gets the value of the attribute: CODE.
String	getConceptualClassname() Deprecated.
String	getMessage() Gets the value of the attribute: MESSAGE.
Timestamp	getRescheduleTime() Gets the value of the attribute: RESCHEDULE_TIME.
protected void	initialize(String status_code) Supports initialization, following construction of an instance.
static StatusInfo	newStatusInfo(String status_code) Constructs an empty status info object.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(StatusInfo thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setCode(String a_Code) Sets the value of the attribute: CODE.
void	setMessage(String a_Message) Sets the value of the attribute: MESSAGE.
void	setRescheduleTime(Timestamp a_RescheduleTime) Sets the value of the attribute: RESCHEDULE_TIME.
String	toString() Returns the conceptual (modeled) name for the class.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

CODE

public static final String CODE

Label for the attribute; Stores the queue entry status code. Can be one of READY, SUSPENDED, EXECUTING, COMPLETED, and FAILED.

Supported API: false

See Also:

Constant Field Values

CODE_UPPER_LIMIT

private static int CODE_UPPER_LIMIT

code

private String code

MESSAGE

public static final String MESSAGE

Label for the attribute; Contains message associated with the execution of the entry. For example, error message in case of FAILED entries.

Supported API: false

See Also:

Constant Field Values

MESSAGE_UPPER_LIMIT

private static int MESSAGE_UPPER_LIMIT

message

private String message

READY

public static final String READY

Constant indicating that the entry is ready to be executed.

Supported API: false

See Also:

Constant Field Values

COMPLETED

public static final String COMPLETED

Constant indicating that the entry has been processed successfully.

Supported API: false

See Also:

Constant Field Values

FAILED

public static final String FAILED

Constant indicating that the entry has been processed unsuccessfully.

Supported API: false

See Also:

Constant Field Values

EXECUTING

public static final String EXECUTING

Constant to indicate that the entry is being executed.

Supported API: false

See Also:

Constant Field Values

SUSPENDED

public static final String SUSPENDED

State of an entry in which it is not chosen for processing. An entry can only get into this state through operator intervention. Normal processing ends up in the FAILED or COMPLETED states.

Supported API: false

See Also:

Constant Field Values

RESCHEDULE

public static final String RESCHEDULE

Used to indicate the entry should be rescheduled

Supported API: false

See Also:

Constant Field Values

RESCHEDULE_TIME

public static final String RESCHEDULE_TIME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

rescheduleTime

private Timestamp rescheduleTime

NOTIFY

public static final String NOTIFY

Indicates that an entry has failed after repeated attempts and that an administrator should be notified.

Supported API: false

See Also:

Constant Field Values

SEVERE

public static final String SEVERE

Denotes that the QueueEntry is failed due to InvocationTargetException or Exception

Supported API: false

See Also:

Constant Field Values

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

StatusInfo

public StatusInfo()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(StatusInfo thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getCode

public String getCode()

Gets the value of the attribute: CODE. Stores the queue entry status code. Can be one of READY, SUSPENDED, EXECUTING, COMPLETED, and FAILED.

Supported API: false

Returns:

String

setCode

public void setCode(String a_Code)

Sets the value of the attribute: CODE. Stores the queue entry status code. Can be one of READY, SUSPENDED, EXECUTING, COMPLETED, and FAILED.

Supported API: false

Parameters:

a_Code -

getMessage

public String getMessage()

Gets the value of the attribute: MESSAGE. Contains message associated with the execution of the entry. For example, error message in case of FAILED entries.

Supported API: false

Returns:

String

setMessage

public void setMessage(String a_Message)

Sets the value of the attribute: MESSAGE. Contains message associated with the execution of the entry. For example, error message in case of FAILED entries.

Supported API: false

Parameters:

a_Message -

getRescheduleTime

public Timestamp getRescheduleTime()

Gets the value of the attribute: RESCHEDULE_TIME.

Supported API: false

Returns:

Timestamp

setRescheduleTime

public void setRescheduleTime(Timestamp a_RescheduleTime)
                       throws WTPropertyVetoException

Sets the value of the attribute: RESCHEDULE_TIME.

Supported API: false

Parameters:

a_RescheduleTime -

Throws:

WTPropertyVetoException

newStatusInfo

public static StatusInfo newStatusInfo(String status_code)
                                throws WTException

Constructs an empty status info object.

Supported API: false

Parameters:

status_code -

Returns:

StatusInfo

Throws:

WTException

initialize

protected void initialize(String status_code)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

status_code -

Throws:

WTException