com.ibm.as400.resource
Class RQueuedMessage

java.lang.Object
  extended bycom.ibm.as400.resource.Resource
      extended bycom.ibm.as400.resource.RQueuedMessage
All Implemented Interfaces:
Serializable

Deprecated. Use QueuedMessage instead, as this package may be removed in the future.

public class RQueuedMessage
extends Resource

The RQueuedMessage class represents a message in a server message queue or job log.

The following attribute IDs are supported:

Use any of these attribute IDs with getAttributeValue() to access the attribute values for an RQueuedMessage.

// Create an RMessageQueue object to refer to a specific message queue.
AS400 system = new AS400("MYSYSTEM", "MYUSERID", "MYPASSWORD");
RMessageQueue messageQueue = new RMessageQueue(system, "/QSYS.LIB/MYLIB.LIB/MYMSGQ.MSGQ");

// Get the first RQueuedMessage from the RMessageQueue. RQueuedMessage queuedMessage = messageQueue.resourceAt(0);
// Get the message text from the RQueuedMessage. String messageText = (String)queuedMessage.getAttributeValue(RQueuedMessage.MESSAGE_TEXT);

See Also:
RMessageQueue, RJobLog, Serialized Form

Field Summary
static String ALERT_OPTION
          Deprecated. Attribute ID for alert option.
static String ALERT_OPTION_DEFER
          Deprecated. Constant for ALERT_OPTION attribute value - An alert is sent after local problem analysis.
static String ALERT_OPTION_IMMEDIATE
          Deprecated. Constant for ALERT_OPTION attribute value - An alert is sent immediately when the message is sent to a message queue that has the allows alerts.
static String ALERT_OPTION_NO
          Deprecated. Constant for ALERT_OPTION attribute value - No alert is sent.
static String ALERT_OPTION_UNATTENDED
          Deprecated. Constant for ALERT_OPTION attribute value - An alert is sent immediately when the system is running in unattended mode.
static String DATE_SENT
          Deprecated. Attribute ID for date sent.
static String DEFAULT_REPLY
          Deprecated. Attribute ID for default reply.
static String MESSAGE_FILE
          Deprecated. Attribute ID for message file.
static String MESSAGE_HELP
          Deprecated. Attribute ID for message help.
static String MESSAGE_ID
          Deprecated. Attribute ID for message ID.
static String MESSAGE_KEY
          Deprecated. Attribute ID for message key.
static String MESSAGE_QUEUE
          Deprecated. Attribute ID for message queue.
static String MESSAGE_SEVERITY
          Deprecated. Attribute ID for message severity.
static String MESSAGE_TEXT
          Deprecated. Attribute ID for message text.
static String MESSAGE_TYPE
          Deprecated. Attribute ID for message type.
static String REPLY_STATUS
          Deprecated. Attribute ID for reply status.
static String REPLY_STATUS_ACCEPTS_NOT_SENT
          Deprecated. Constant for REPLY_STATUS attribute value - Message accepts a reply, and a reply has not been sent.
static String REPLY_STATUS_ACCEPTS_SENT
          Deprecated. Constant for REPLY_STATUS attribute value - Message accepts a reply, and a reply has been sent.
static String REPLY_STATUS_NOT_ACCEPT
          Deprecated. Constant for REPLY_STATUS attribute value - Message does not accept a reply.
static String SENDER_JOB_NAME
          Deprecated. Attribute ID for sender job name.
static String SENDER_JOB_NUMBER
          Deprecated. Attribute ID for sender job number.
static String SENDER_USER_NAME
          Deprecated. Attribute ID for sender user name.
static String SENDING_PROGRAM_NAME
          Deprecated. Attribute ID for sending program name.
static String SUBSTITUTION_DATA
          Deprecated. Attribute ID for substitution data.
 
Constructor Summary
RQueuedMessage()
          Deprecated. Constructs an RQueuedMessage object.
 
Method Summary
 void load(int helpTextFormatting)
          Deprecated. Reload message help text.
 
Methods inherited from class com.ibm.as400.resource.Resource
addActiveStatusListener, addPropertyChangeListener, addResourceListener, addVetoableChangeListener, arePropertiesFrozen, equals, establishConnection, fireAttributeValuesRefreshed, fireBusy, fireIdle, firePropertyChange, fireVetoableChange, freezeProperties, getAttributeMetaData, getAttributeMetaData, getAttributeValue, getAttributeValue, getPresentation, getResourceKey, getSystem, initializeAttributeValue, isBidiEnabled, isConnectionEstablished, refreshAttributeValues, removeActiveStatusListener, removePropertyChangeListener, removeResourceListener, removeVetoableChangeListener, setPresentation, setResourceKey, setSystem, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ALERT_OPTION

public static final String ALERT_OPTION
Deprecated. 
Attribute ID for alert option. This identifies a read-only String attribute, which represents whether and when an SNA alert is created and sent for the message. Possible values are:

See Also:
Constant Field Values

ALERT_OPTION_DEFER

public static final String ALERT_OPTION_DEFER
Deprecated. 
Constant for ALERT_OPTION attribute value - An alert is sent after local problem analysis.

See Also:
Constant Field Values

ALERT_OPTION_IMMEDIATE

public static final String ALERT_OPTION_IMMEDIATE
Deprecated. 
Constant for ALERT_OPTION attribute value - An alert is sent immediately when the message is sent to a message queue that has the allows alerts.

See Also:
Constant Field Values

ALERT_OPTION_NO

public static final String ALERT_OPTION_NO
Deprecated. 
Constant for ALERT_OPTION attribute value - No alert is sent.

See Also:
Constant Field Values

ALERT_OPTION_UNATTENDED

public static final String ALERT_OPTION_UNATTENDED
Deprecated. 
Constant for ALERT_OPTION attribute value - An alert is sent immediately when the system is running in unattended mode.

See Also:
Constant Field Values

DATE_SENT

public static final String DATE_SENT
Deprecated. 
Attribute ID for date sent. This identifies a read-only Date attribute, which represents the date and time on which the message was sent. The Date value is converted using the default Java locale.

See Also:
Constant Field Values

DEFAULT_REPLY

public static final String DEFAULT_REPLY
Deprecated. 
Attribute ID for default reply. This identifies a read-only String attribute, which represents the text of the default reply when a stored message is being listed, and a default reply exists.

See Also:
Constant Field Values

MESSAGE_FILE

public static final String MESSAGE_FILE
Deprecated. 
Attribute ID for message file. This identifies a read-only String attribute, which represents the fully qualified integrated file system path name of the message file containing the message.

See Also:
QSYSObjectPathName, Constant Field Values

MESSAGE_HELP

public static final String MESSAGE_HELP
Deprecated. 
Attribute ID for message help. This identifies a read-only String attribute, which represents the message help.

See Also:
Constant Field Values

MESSAGE_ID

public static final String MESSAGE_ID
Deprecated. 
Attribute ID for message ID. This identifies a read-only String attribute, which represents the message identifier.

See Also:
Constant Field Values

MESSAGE_KEY

public static final String MESSAGE_KEY
Deprecated. 
Attribute ID for message key. This identifies a read-only byte array attribute, which represents the message key.

See Also:
Constant Field Values

MESSAGE_QUEUE

public static final String MESSAGE_QUEUE
Deprecated. 
Attribute ID for message queue. This identifies a read-only String attribute, which represents the fully qualified integrated file system path name of the message queue.

See Also:
QSYSObjectPathName, Constant Field Values

MESSAGE_SEVERITY

public static final String MESSAGE_SEVERITY
Deprecated. 
Attribute ID for message severity. This identifies a read-only Integer attribute, which represents the severity of the message. Possible values are 0 through 99.

See Also:
Constant Field Values

MESSAGE_TEXT

public static final String MESSAGE_TEXT
Deprecated. 
Attribute ID for message text. This identifies a read-only String attribute, which represents the message text.

See Also:
Constant Field Values

MESSAGE_TYPE

public static final String MESSAGE_TYPE
Deprecated. 
Attribute ID for message type. This identifies a read-only Integer attribute, which represents the message type. Converted to an int, the possible values are:

See Also:
Constant Field Values

REPLY_STATUS

public static final String REPLY_STATUS
Deprecated. 
Attribute ID for reply status. This identifies a read-only String attribute, which represents the reply status of the message. Possible values are:

See Also:
Constant Field Values

REPLY_STATUS_ACCEPTS_SENT

public static final String REPLY_STATUS_ACCEPTS_SENT
Deprecated. 
Constant for REPLY_STATUS attribute value - Message accepts a reply, and a reply has been sent.

See Also:
Constant Field Values

REPLY_STATUS_ACCEPTS_NOT_SENT

public static final String REPLY_STATUS_ACCEPTS_NOT_SENT
Deprecated. 
Constant for REPLY_STATUS attribute value - Message accepts a reply, and a reply has not been sent. (The message is waiting for a reply.)

See Also:
Constant Field Values

REPLY_STATUS_NOT_ACCEPT

public static final String REPLY_STATUS_NOT_ACCEPT
Deprecated. 
Constant for REPLY_STATUS attribute value - Message does not accept a reply.

See Also:
Constant Field Values

SENDER_JOB_NAME

public static final String SENDER_JOB_NAME
Deprecated. 
Attribute ID for sender job name. This identifies a read-only String attribute, which represents the job name of the sender.

See Also:
Constant Field Values

SENDER_USER_NAME

public static final String SENDER_USER_NAME
Deprecated. 
Attribute ID for sender user name. This identifies a read-only String attribute, which represents the user name of the sender.

See Also:
Constant Field Values

SENDER_JOB_NUMBER

public static final String SENDER_JOB_NUMBER
Deprecated. 
Attribute ID for sender job number. This identifies a read-only String attribute, which represents the job number of the sender.

See Also:
Constant Field Values

SENDING_PROGRAM_NAME

public static final String SENDING_PROGRAM_NAME
Deprecated. 
Attribute ID for sending program name. This identifies a read-only String attribute, which represents the sending program name or ILE program name that contains the procedure sending the message.

See Also:
Constant Field Values

SUBSTITUTION_DATA

public static final String SUBSTITUTION_DATA
Deprecated. 
Attribute ID for substitution data. This identifies a read-only byte array attribute, which represents the values for subsitution variables in a predefined message, or the text of an impromptu message.

See Also:
Constant Field Values
Constructor Detail

RQueuedMessage

public RQueuedMessage()
Deprecated. 
Constructs an RQueuedMessage object.

Method Detail

load

public void load(int helpTextFormatting)
          throws AS400SecurityException,
                 ErrorCompletingRequestException,
                 IOException,
                 InterruptedException,
                 ObjectDoesNotExistException
Deprecated. 
Reload message help text.

Parameters:
helpTextFormatting - Formatting performed on the help text. Valid values for this parameter are defined in the MessageFile class. They are no formatting, return formatting characters, and replace (substitute) formatting characters.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
IOException - If an error occurs while communicating with the server.
InterruptedException - If this thread is interrupted.
ObjectDoesNotExistException - If the server object does not exist.