Package wt.queue

Class StatusInfo

java.lang.Object

wt.queue._StatusInfo

wt.queue.StatusInfo

All Implemented Interfaces:

Externalizable, Serializable, wt.fc._NetFactor, wt.fc._ObjectMappable, NetFactor, ObjectMappable

@GenAsObjectMappable(versions=8536382387610551220L,properties={@GeneratedProperty(name="code",type=java.lang.String.class,supportedAPI=PRIVATE,javaDoc="Stores the queue entry status code.  Can be one of READY, SUSPENDED,  EXECUTING, COMPLETED, and FAILED.",accessors=@PropertyAccessors(setExceptions={}),constraints=@PropertyConstraints(upperLimit=30)),@GeneratedProperty(name="message",type=java.lang.String.class,supportedAPI=PRIVATE,javaDoc="Contains message associated with the execution of the entry.  For example, error message in case of FAILED entries.",accessors=@PropertyAccessors(setExceptions={}),constraints=@PropertyConstraints(upperLimit=4000)),@GeneratedProperty(name="rescheduleTime",type=java.sql.Timestamp.class)})
public class StatusInfo
extends wt.queue._StatusInfo

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: true

Extendable: false

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPLETED	Constant indicating that the entry has been processed successfully.
static final String	DELETECOMPLETED	Constant indicating that the entry has completed successfully but that we want to delete it even when the property wt.queue.removeCompleted.queueName is set to false This status is only valid for process queue entries at this time and is only used specifically by WVS Supported API: true
static final String	EXECUTING	Constant to indicate that the entry is being executed.
static final String	FAILED	Constant indicating that the entry has been processed unsuccessfully.
static final String	NONEVENTFAILED	Constant indicating that the entry has been processed unsuccessfully but that normal failure processing should be bypassed.
static final String	NOTIFY	Indicates that an entry has failed after repeated attempts and that an administrator should be notified.
static final String	READY	Constant indicating that the entry is ready to be executed.
static final String	RESCHEDULE	Used to indicate the entry should be rescheduled Supported API: true
static final String	SEVERE	Denotes that the QueueEntry is failed due to InvocationTargetException or Exception Supported API: true
static final String	SUSPENDED	State of an entry in which it is not chosen for processing.

Method Summary

Modifier and Type	Method	Description
void	setMessage(String a_Message)	Sets the value of the attribute: MESSAGE.
String	toString()	Returns the conceptual (modeled) name for the class.

Methods inherited from class java.lang.Object

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

Field Details

READY

public static final String READY

Constant indicating that the entry is ready to be executed.

Supported API: true

See Also:

• Constant Field Values

COMPLETED

public static final String COMPLETED

Constant indicating that the entry has been processed successfully.

Supported API: true

See Also:

• Constant Field Values

FAILED

public static final String FAILED

Constant indicating that the entry has been processed unsuccessfully.

Supported API: true

See Also:

• Constant Field Values

NONEVENTFAILED

public static final String NONEVENTFAILED

Constant indicating that the entry has been processed unsuccessfully but that normal failure processing should be bypassed. This status is only valid for process queue entries at this time and is only used specifically by WVS

Supported API: true

See Also:

• Constant Field Values

DELETECOMPLETED

public static final String DELETECOMPLETED

Constant indicating that the entry has completed successfully but that we want to delete it even when the property wt.queue.removeCompleted.queueName is set to false This status is only valid for process queue entries at this time and is only used specifically by WVS

Supported API: true

See Also:

• Constant Field Values

EXECUTING

public static final String EXECUTING

Constant to indicate that the entry is being executed.

Supported API: true

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: true

See Also:

• Constant Field Values

RESCHEDULE

public static final String RESCHEDULE

Used to indicate the entry should be rescheduled

Supported API: true

See Also:

• Constant Field Values

NOTIFY

public static final String NOTIFY

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

Supported API: true

See Also:

• Constant Field Values

SEVERE

public static final String SEVERE

Denotes that the QueueEntry is failed due to InvocationTargetException or Exception

Supported API: true

See Also:

• Constant Field Values

Method Details

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: true

Overrides:

toString in class wt.queue._StatusInfo

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: true

Overrides:

setMessage in class wt.queue._StatusInfo

Parameters:

a_Message -