com.ibm.as400.access
Class QueuedMessage

java.lang.Object
  |
  +--com.ibm.as400.access.AS400Message
        |
        +--com.ibm.as400.access.QueuedMessage

All Implemented Interfaces:

java.io.Serializable

public class QueuedMessage

extends AS400Message

implements java.io.Serializable

The QueuedMessage class represents a message on an OS/400 message queue or job log.

See Also:

MessageQueue, JobLog, Serialized Form

Field Summary

Fields inherited from class com.ibm.as400.access.AS400Message

COMPLETION, DIAGNOSTIC, ESCAPE, ESCAPE_NOT_HANDLED, INFORMATIONAL, INQUIRY, MESSAGE_OPTION_ALL, MESSAGE_OPTION_NONE, MESSAGE_OPTION_UP_TO_10, NOTIFY, NOTIFY_NOT_HANDLED, REPLY_FROM_SYSTEM_REPLY_LIST, REPLY_MESSAGE_DEFAULT_USED, REPLY_NOT_VALIDITY_CHECKED, REPLY_SYSTEM_DEFAULT_USED, REPLY_VALIDITY_CHECKED, REQUEST, REQUEST_WITH_PROMPTING, SENDERS_COPY

Method Summary

java.lang.String	getAlertOption() Returns the alert option.
java.lang.String	getCurrentUser() Returns the current user name.
java.lang.String	getFromJobName() Returns the sender job name.
java.lang.String	getFromJobNumber() Returns the sender job number.
java.lang.String	getFromProgram() Returns the sending program name.
byte[]	getKey() Returns the 4-byte message key.
MessageQueue	getQueue() Returns the message queue.
java.lang.String	getReplyStatus() Returns the reply status.
java.lang.String	getUser() Returns the sender job's user.
java.lang.String	toString() Returns the String representation of this QueuedMessage object.

Methods inherited from class com.ibm.as400.access.AS400Message

getDate, getDefaultReply, getFileName, getHelp, getID, getLibraryName, getPath, getSeverity, getSubstitutionData, getText, getType, load, load

Methods inherited from class java.lang.Object

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

Method Detail

getAlertOption

public java.lang.String getAlertOption()

Returns the alert option. Possible values are:

• *DEFER - An alert is sent after local problem analysis.
• *IMMED - An alert is sent immediately when the message is sent to a message queue that has the allow alerts attribute set to *YES.
• *NO - No alert is sent.
• *UNATTEND - An alert is sent immediately when the system is running in unattended mode. See the ALRSTS network attribute.
• "" - The alert option was not specified when the message was sent.

Returns:

One of the above values.

getFromProgram

public java.lang.String getFromProgram()

Returns the sending program name.

Returns:

The sending program name, or "" if it is not set.

getFromJobName

public java.lang.String getFromJobName()

Returns the sender job name.

Returns:

The sender job name, or "" if it is not set.

See Also:

getFromJobNumber(), getUser()

getFromJobNumber

public java.lang.String getFromJobNumber()

Returns the sender job number.

Returns:

The sender job number, or "" if it is not set.

See Also:

getFromJobName(), getUser()

getUser

public java.lang.String getUser()

Returns the sender job's user. To get the current user of the message, call getCurrentUser() when accessing a system running OS/400 V5R3 or higher.

Returns:

The sender job's user, or "" if it is not set.

See Also:

getFromJobName(), getFromJobNumber()

getKey

public byte[] getKey()

Returns the 4-byte message key.

Returns:

The message key, or null if it is not set.

getQueue

public MessageQueue getQueue()

Returns the message queue.

Returns:

The message queue, or null if it is not set.

getReplyStatus

public java.lang.String getReplyStatus()

Returns the reply status.

Returns:

The reply status, "" if it is not set, or null if it is not applicable.

getCurrentUser

public java.lang.String getCurrentUser()

Returns the current user name. If the system being accessed is running OS/400 V5R2 or earlier, then "" is returned.

Returns:

The current user name, or "" if it is not set.

toString

public java.lang.String toString()

Returns the String representation of this QueuedMessage object.

Overrides:

toString in class AS400Message

Returns:

The string.