wt.scheduler
Class SchedStatusInfo

java.lang.Object
  wt.queue.StatusInfo
      wt.scheduler.SchedStatusInfo

All Implemented Interfaces:

Evolvable, Externalizable, NetFactor, ObjectMappable, Serializable

public class SchedStatusInfo

extends StatusInfo

implements Evolvable

Represents the status of a Schedule Item. Conteains a code and an optional message.

Use the newSchedStatusInfo static factory method(s), not the SchedStatusInfo 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

static String	ABORTED Constant indicating that the processing has been aborted for this entry.
private static String	CLASSNAME
static String	ERROR_COMPLETED Supported API: false
static String	ERROR_CONTINUED Supported API: false
static String	ERROR_STOPPED Supported API: false
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.queue.StatusInfo

CODE, COMPLETED, EXECUTING, FAILED, MESSAGE, NOTIFY, READY, RESCHEDULE, RESCHEDULE_TIME, SEVERE, SUSPENDED

Constructor Summary

SchedStatusInfo()

Method Summary

String	getConceptualClassname() Deprecated.
WTMessage	getSummaryMessage() Return the status code in the format of WTMessage.
protected void	initialize(String status_code) Supports initialization, following construction of an instance.
static SchedStatusInfo	newSchedStatusInfo(String status_code) Supported API: false
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(SchedStatusInfo thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
String	toString() Supported API: false
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 wt.queue.StatusInfo

getClassInfo, getCode, getMessage, getRescheduleTime, newStatusInfo, readVersion, setCode, setMessage, setRescheduleTime

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

ABORTED

public static final String ABORTED

Constant indicating that the processing has been aborted for this entry.

Supported API: false

See Also:

Constant Field Values

ERROR_CONTINUED

public static final String ERROR_CONTINUED

Supported API: false

See Also:

Constant Field Values

ERROR_COMPLETED

public static final String ERROR_COMPLETED

Supported API: false

See Also:

Constant Field Values

ERROR_STOPPED

public static final String ERROR_STOPPED

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

SchedStatusInfo

public SchedStatusInfo()

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

Overrides:

writeExternal in class StatusInfo

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

Overrides:

readExternal in class StatusInfo

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(SchedStatusInfo 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

Overrides:

writeExternal in class StatusInfo

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

Overrides:

readExternal in class StatusInfo

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

Overrides:

getConceptualClassname in class StatusInfo

Returns:

String

newSchedStatusInfo

public static SchedStatusInfo newSchedStatusInfo(String status_code)
                                          throws WTException

Supported API: false

Parameters:

status_code -

Returns:

SchedStatusInfo

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

Overrides:

initialize in class StatusInfo

Parameters:

status_code -

Throws:

WTException

toString

public String toString()

Supported API: false

Overrides:

toString in class StatusInfo

Returns:

String

getSummaryMessage

public WTMessage getSummaryMessage()

Return the status code in the format of WTMessage.

Supported API: false

Returns:

WTMessage