com.ibm.as400.access
Class MessageQueue

java.lang.Object
  |
  +--com.ibm.as400.access.MessageQueue
All Implemented Interfaces:
java.io.Serializable

public class MessageQueue
extends java.lang.Object
implements java.io.Serializable

The MessageQueue class represents an AS/400 message queue. If no message queue path is set, then the default is CURRENT, which represents the current user's message queue, /QSYS.LIB/QUSRSYS.LIB/userID.MSGQ.

Some of the selections have associated get and set methods defined in this class. These are provided for backwards compatibility with previous versions of the AS/400 Toolbox for Java. The complete set of selections can be accessed using the RMessageQueue class.

QueuedMessage objects have many attributes. Only some of these attribute values are set, depending on how a QueuedMessage object is created. The following is a list of attributes whose values are set on QueuedMessage objects returned in a list of messages:

The following is a list of attributes whose values are set on objects returned by receive():

See Also:
RMessageQueue, Serialized Form

Field Summary
static java.lang.String ALL
          Constant referring to all messages in the message queue.
static java.lang.String ANY
          Constant referring to any message in the message queue.
static java.lang.String BYKEY
          Constant referring to a message identified by a key.
static java.lang.String COMPLETION
          Constant referring to completion messages.
static java.lang.String COPY
          Constant referring to the sender's copy of a previously sent inquiry message.
static java.lang.String CURRENT
          Constant referring to the current user's message queue.
static java.lang.String DIAGNOSTIC
          Constant referring to diagnostic messages.
static java.lang.String FIRST
          Constant referring to the first message in the message queue.
static java.lang.String INFORMATIONAL
          Constant referring to informational messages.
static java.lang.String INQUIRY
          Constant referring to inquiry messages.
static java.lang.String KEEP_UNANSWERED
          Constant referring to all messages in the message queue except unanswered inquiry and unanswered senders' copy messages.
static java.lang.String LAST
          Constant referring to the last message in the message queue.
static java.lang.String MESSAGES_NEED_REPLY
          Constant referring to messages that need a reply.
static java.lang.String MESSAGES_NO_NEED_REPLY
          Constant referring to messages that do not need a reply.
static java.lang.String NEW
          Constant referring to all new messages in the message queue.
static byte[] NEWEST
          Constant referring to the message key for the newest message in the queue.
static java.lang.String NEXT
          Constant referring to the next message in the message queue.
static java.lang.String OLD
          Constant referring to all old messages in the message queue.
static byte[] OLDEST
          Constant referring to the message key for the oldest message in the queue.
static java.lang.String PREVIOUS
          Constant referring to the previous message in the message queue.
static java.lang.String REMOVE
          Constant indicating that the message should be removed from the message queue.
static java.lang.String REPLY
          Constant referring to the reply to an inquiry message.
static java.lang.String SAME
          Constant indicating that the message should remain in the message queue without changing its new or old designation.
static java.lang.String SENDERS_COPY_NEED_REPLY
          Constant referring to the sender's copies of messages that need replies.
 
Constructor Summary
MessageQueue()
          Constructs a MessageQueue object.
MessageQueue(AS400 system)
          Constructs a MessageQueue object.
MessageQueue(AS400 system, java.lang.String path)
          Constructs a MessageQueue object.
 
Method Summary
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Adds a PropertyChangeListener.
 void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
          Adds a VetoableChangeListener.
 int getHelpTextFormatting()
          Returns the status of help text formatting.
 int getLength()
          Returns the number of messages in the message queue.
 boolean getListDirection()
          Returns the list direction.
 java.util.Enumeration getMessages()
          Returns the list of messages in the message queue.
 java.lang.String getPath()
          Returns the fully qualified integrated file system path name of the message queue, or CURRENT to refer to the user's default message queue.
 java.lang.String getSelection()
          Returns the selection that describes which messages are returned.
 int getSeverity()
          Returns the severity of the messages which are returned.
 AS400 getSystem()
          Returns the system.
 QueuedMessage receive(byte[] messageKey)
          Receives a message from the message queue by key.
 QueuedMessage receive(byte[] messageKey, int waitTime, java.lang.String messageAction, java.lang.String messageType)
          Receives a message from the message queue.
 void remove()
          Remove all messages from the message queue.
 void remove(byte[] messageKey)
          Removes a message from the message queue.
 void remove(java.lang.String messageType)
          Remove messages from the message queue.
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Removes a PropertyChangeListener.
 void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
          Removes a VetoableChangeListener.
 void reply(byte[] messageKey, java.lang.String replyText)
          Replies to and removes a message.
 void reply(byte[] messageKey, java.lang.String replyText, boolean remove)
          Replies to and removes a message if requested.
 void sendInformational(java.lang.String messageText)
          Sends an informational message to the message queue.
 void sendInformational(java.lang.String messageID, java.lang.String messageFile)
          Sends an informational message to the message queue.
 void sendInformational(java.lang.String messageID, java.lang.String messageFile, byte[] substitutionData)
          Sends an informational message to the message queue.
 byte[] sendInquiry(java.lang.String messageText, java.lang.String replyMessageQueue)
          Sends an inquiry message to the message queue.
 byte[] sendInquiry(java.lang.String messageID, java.lang.String messageFile, byte[] substitutionData, java.lang.String replyMessageQueue)
          Sends an inquiry message to the message queue.
 byte[] sendInquiry(java.lang.String messageID, java.lang.String messageFile, java.lang.String replyMessageQueue)
          Sends an inquiry message to the message queue.
 void setHelpTextFormatting(int helpTextFormatting)
          Sets the help text formatting value.
 void setListDirection(boolean listDirection)
          Sets the list direction.
 void setPath(java.lang.String path)
          Sets the fully qualified integrated file system path name of the message queue.
 void setSelection(java.lang.String selection)
          Sets the selection that describes which messages are returned.
 void setSeverity(int severity)
          Sets the severity of the messages which are returned.
 void setSystem(AS400 system)
          Sets the system.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ALL

public static final java.lang.String ALL
Constant referring to all messages in the message queue.

ANY

public static final java.lang.String ANY
Constant referring to any message in the message queue.

BYKEY

public static final java.lang.String BYKEY
Constant referring to a message identified by a key.

COMPLETION

public static final java.lang.String COMPLETION
Constant referring to completion messages.

COPY

public static final java.lang.String COPY
Constant referring to the sender's copy of a previously sent inquiry message.

CURRENT

public static final java.lang.String CURRENT
Constant referring to the current user's message queue.

DIAGNOSTIC

public static final java.lang.String DIAGNOSTIC
Constant referring to diagnostic messages.

FIRST

public static final java.lang.String FIRST
Constant referring to the first message in the message queue.

INFORMATIONAL

public static final java.lang.String INFORMATIONAL
Constant referring to informational messages.

INQUIRY

public static final java.lang.String INQUIRY
Constant referring to inquiry messages.

KEEP_UNANSWERED

public static final java.lang.String KEEP_UNANSWERED
Constant referring to all messages in the message queue except unanswered inquiry and unanswered senders' copy messages.

LAST

public static final java.lang.String LAST
Constant referring to the last message in the message queue.

MESSAGES_NEED_REPLY

public static final java.lang.String MESSAGES_NEED_REPLY
Constant referring to messages that need a reply.

MESSAGES_NO_NEED_REPLY

public static final java.lang.String MESSAGES_NO_NEED_REPLY
Constant referring to messages that do not need a reply.

NEW

public static final java.lang.String NEW
Constant referring to all new messages in the message queue. New messages are those that have not been received.

NEWEST

public static final byte[] NEWEST
Constant referring to the message key for the newest message in the queue.

NEXT

public static final java.lang.String NEXT
Constant referring to the next message in the message queue.

OLD

public static final java.lang.String OLD
Constant referring to all old messages in the message queue. Old messages are those that have already been received.

OLDEST

public static final byte[] OLDEST
Constant referring to the message key for the oldest message in the queue.

PREVIOUS

public static final java.lang.String PREVIOUS
Constant referring to the previous message in the message queue.

REMOVE

public static final java.lang.String REMOVE
Constant indicating that the message should be removed from the message queue.

REPLY

public static final java.lang.String REPLY
Constant referring to the reply to an inquiry message.

SAME

public static final java.lang.String SAME
Constant indicating that the message should remain in the message queue without changing its new or old designation.

SENDERS_COPY_NEED_REPLY

public static final java.lang.String SENDERS_COPY_NEED_REPLY
Constant referring to the sender's copies of messages that need replies.
Constructor Detail

MessageQueue

public MessageQueue()
Constructs a MessageQueue object.

MessageQueue

public MessageQueue(AS400 system)
Constructs a MessageQueue object.
Parameters:
system - The system.

MessageQueue

public MessageQueue(AS400 system,
                    java.lang.String path)
Constructs a MessageQueue object.
Parameters:
system - The system.
path - The fully qualified integrated file system path name of the message queue, or CURRENT to refer to the user's default message queue.
Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener. The specified PropertyChangeListener's propertyChange() method will be called each time the value of any bound property is changed.
Parameters:
listener - The listener.

addVetoableChangeListener

public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
Adds a VetoableChangeListener. The specified VetoableChangeListener's vetoableChange() method will be called each time the value of any constrained property is changed.
Parameters:
listener - The listener.

getLength

public int getLength()
Returns the number of messages in the message queue.
Returns:
The number of messages, or 0 if no list has been retrieved.

getHelpTextFormatting

public int getHelpTextFormatting()
Returns the status of help text formatting. Possible values are:
Returns:
The status of help text formatting.

getListDirection

public boolean getListDirection()
Returns the list direction.
Returns:
true if the messages are listed in order from oldest to newest; false if the messages are listed in order from newest to oldest.

getMessages

public java.util.Enumeration getMessages()
                                  throws AS400Exception,
                                         AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         java.lang.InterruptedException,
                                         java.io.IOException,
                                         ObjectDoesNotExistException
Returns the list of messages in the message queue.
Returns:
An Enumeration of QueuedMessage objects.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.

getPath

public java.lang.String getPath()
Returns the fully qualified integrated file system path name of the message queue, or CURRENT to refer to the user's default message queue.
Returns:
The fully qualified integrated file system path name of the message queue, or CURRENT to refer to the user's default message queue.

getSelection

public java.lang.String getSelection()
Returns the selection that describes which messages are returned.
Returns:
The selection. Possible values are:
See Also:
RMessageQueue.SELECTION_CRITERIA

getSeverity

public int getSeverity()
Returns the severity of the messages which are returned.
Returns:
The severity of the messages which are returned.
See Also:
RMessageQueue.SEVERITY_CRITERIA

getSystem

public AS400 getSystem()
Returns the system.
Returns:
The system.

receive

public QueuedMessage receive(byte[] messageKey)
                      throws AS400Exception,
                             AS400SecurityException,
                             java.io.IOException,
                             ObjectDoesNotExistException,
                             ErrorCompletingRequestException,
                             java.lang.InterruptedException
Receives a message from the message queue by key. This method receives a message of any type except sender's copy. The message is removed from the message queue. See the list of QueuedMessage attribute values which are set on a received message.
Parameters:
messageKey - The message key.
Returns:
The queued message, or null if the message can not be received.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
See Also:
QueuedMessage.getKey()

receive

public QueuedMessage receive(byte[] messageKey,
                             int waitTime,
                             java.lang.String messageAction,
                             java.lang.String messageType)
                      throws AS400Exception,
                             AS400SecurityException,
                             java.io.IOException,
                             ObjectDoesNotExistException,
                             ErrorCompletingRequestException,
                             java.lang.InterruptedException
Receives a message from the message queue. See the list of QueuedMessage attribute values which are set on a received message.
Parameters:
messageKey - The message key, or null if no message key is needed.
waitTime - The number of seconds to wait for the message to arrive in the queue so it can be received. If the message is not received within the specified wait time, null is returned. Special values are:
  • 0 - Do not wait for the message. If the message is not in the queue and you specified a message key, null is returned.
  • -1 - Wait until the message arrives in the queue and is received, no matter how long it takes. The system has no limit for the wait time.
messageAction - The action to take after the message is received. Valid values are:
  • OLD - Keep the message in the message queue and mark it as an old message. You can receive the message again only by using the message key or by specifying the message type NEXT, PREVIOUS, FIRST, or LAST.
  • REMOVE - Remove the message from the message queue. The message key is no longer valid, so you cannot receive the message again.
  • SAME - Keep the message in the message queue without changing its new or old designation. SAME lets you receive the message again later without using the message key.
messageType - The type of message to return. Valid values are:
  • ANY - Receives a message of any type except sender's copy. The message key is optional.
  • COMPLETION - Receives a completion message. The message key is optional.
  • COPY - Receives the sender's copy of a previously sent inquiry message. The message key is required.
  • DIAGNOSTIC - Receives a diagnostic message. The message key is optional.
  • FIRST - Receives the first new or old message in the queue. The message key is disallowed.
  • INFORMATIONAL - Receives an informational message. The message key is optional.
  • INQUIRY - Receives an inquiry message. If the action is REMOVE and a reply to the inquiry message has not been sent yet, the default reply is automatically sent when the inquiry message is received. The message key is optional.
  • LAST - Receives the last new or old message in the queue. The message key is disallowed.
  • NEXT - Receives the next new or old message after the message with the specified key. You can use the special value TOP for the message key. TOP designates the message at the top of the message queue. The message key is required.
  • PREVIOUS - Receives the new or old message before the message with the specified key. The message key is required.
  • REPLY - Receives the reply to an inquiry message. For the message key, you can use the key to the sender's copy of the inquiry or notify message. The message key is optional.
Returns:
The queued message, or null if the message can not be received.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
See Also:
QueuedMessage.getKey()

remove

public void remove()
            throws AS400Exception,
                   AS400SecurityException,
                   java.io.IOException,
                   ObjectDoesNotExistException,
                   ErrorCompletingRequestException,
                   java.lang.InterruptedException
Remove all messages from the message queue.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.

remove

public void remove(byte[] messageKey)
            throws AS400Exception,
                   AS400SecurityException,
                   java.io.IOException,
                   ObjectDoesNotExistException,
                   ErrorCompletingRequestException,
                   java.lang.InterruptedException
Removes a message from the message queue.
Parameters:
messageKey - The message key.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.

remove

public void remove(java.lang.String messageType)
            throws AS400Exception,
                   AS400SecurityException,
                   java.io.IOException,
                   ObjectDoesNotExistException,
                   ErrorCompletingRequestException,
                   java.lang.InterruptedException
Remove messages from the message queue.
Parameters:
messageType - The type of message to remove. Valid values are:
  • ALL - All messages in the message queue.
  • KEEP_UNANSWERED - All messages in the message queue except unanswered inquiry and unanswered senders' copy messages.
  • NEW - All new messages in the message queue. New messages are those that have not been received.
  • OLD - All old messages in the message queue. Old messages are those that have already been received.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a PropertyChangeListener.
Parameters:
listener - The listener.

removeVetoableChangeListener

public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
Removes a VetoableChangeListener.
Parameters:
listener - The listener.

reply

public void reply(byte[] messageKey,
                  java.lang.String replyText)
           throws AS400Exception,
                  AS400SecurityException,
                  java.io.IOException,
                  ObjectDoesNotExistException,
                  ErrorCompletingRequestException,
                  java.lang.InterruptedException
Replies to and removes a message.
Parameters:
messageKey - The message key.
replyText - The reply.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.

reply

public void reply(byte[] messageKey,
                  java.lang.String replyText,
                  boolean remove)
           throws AS400Exception,
                  AS400SecurityException,
                  java.io.IOException,
                  ObjectDoesNotExistException,
                  ErrorCompletingRequestException,
                  java.lang.InterruptedException
Replies to and removes a message if requested.
Parameters:
messageKey - The message key.
replyText - The reply.
remove - true to remove the inquiry message and the reply from the message queue after the reply is sent, false to keep the inquiry message and the reply after the reply is sent.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.

sendInformational

public void sendInformational(java.lang.String messageID,
                              java.lang.String messageFile)
                       throws AS400Exception,
                              AS400SecurityException,
                              java.io.IOException,
                              ObjectDoesNotExistException,
                              ErrorCompletingRequestException,
                              java.lang.InterruptedException
Sends an informational message to the message queue.
Parameters:
messageID - The message ID.
messageFile - The integrated file system path name of the message file.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.

sendInformational

public void sendInformational(java.lang.String messageID,
                              java.lang.String messageFile,
                              byte[] substitutionData)
                       throws AS400Exception,
                              AS400SecurityException,
                              java.io.IOException,
                              ObjectDoesNotExistException,
                              ErrorCompletingRequestException,
                              java.lang.InterruptedException
Sends an informational message to the message queue.
Parameters:
messageID - The message ID.
messageFile - The integrated file system path name of the message file.
substitutionData - The substitution data for the message, or null if none.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.

sendInformational

public void sendInformational(java.lang.String messageText)
                       throws AS400Exception,
                              AS400SecurityException,
                              java.io.IOException,
                              ObjectDoesNotExistException,
                              ErrorCompletingRequestException,
                              java.lang.InterruptedException
Sends an informational message to the message queue.
Parameters:
messageText - The message text.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.

sendInquiry

public byte[] sendInquiry(java.lang.String messageID,
                          java.lang.String messageFile,
                          java.lang.String replyMessageQueue)
                   throws AS400Exception,
                          AS400SecurityException,
                          java.io.IOException,
                          ObjectDoesNotExistException,
                          ErrorCompletingRequestException,
                          java.lang.InterruptedException
Sends an inquiry message to the message queue.
Parameters:
messageID - The message ID.
messageFile - The integrated file system path name of the message file.
replyMessageQueue - The integrated file system path name of the reply message queue.
Returns:
The message key.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.

sendInquiry

public byte[] sendInquiry(java.lang.String messageID,
                          java.lang.String messageFile,
                          byte[] substitutionData,
                          java.lang.String replyMessageQueue)
                   throws AS400Exception,
                          AS400SecurityException,
                          java.io.IOException,
                          ObjectDoesNotExistException,
                          ErrorCompletingRequestException,
                          java.lang.InterruptedException
Sends an inquiry message to the message queue.
Parameters:
messageID - The message ID.
messageFile - The integrated file system path name of the message file.
substitutionData - The substitution data for the message, or null if none.
replyMessageQueue - The integrated file system path name of the reply message queue.
Returns:
The message key.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.

sendInquiry

public byte[] sendInquiry(java.lang.String messageText,
                          java.lang.String replyMessageQueue)
                   throws AS400Exception,
                          AS400SecurityException,
                          java.io.IOException,
                          ObjectDoesNotExistException,
                          ErrorCompletingRequestException,
                          java.lang.InterruptedException
Sends an inquiry message to the message queue.
Parameters:
messageText - The message text.
replyMessageQueue - The integrated file system path name of the reply message queue.
Returns:
The message key.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.

setHelpTextFormatting

public void setHelpTextFormatting(int helpTextFormatting)
Sets the help text formatting value. Possible values are:
Parameters:
value - The help text formatting value.

setListDirection

public void setListDirection(boolean listDirection)
Sets the list direction.
Parameters:
listDirection - true to list the messages in order from oldest to newest; false to list the messages in order from newest to oldest. The default is true.

setPath

public void setPath(java.lang.String path)
             throws java.beans.PropertyVetoException
Sets the fully qualified integrated file system path name of the message queue. The default is CURRENT. The path cannot be changed if the MessageQueue object has established a connection to the AS/400.
Parameters:
path - The fully qualified integrated file system path name of the message queue, or CURRENT to refer to the user's default message queue.
Throws:
java.beans.PropertyVetoException - If the change is vetoed.

setSelection

public void setSelection(java.lang.String selection)
                  throws java.beans.PropertyVetoException
Sets the selection that describes which messages are returned. The default is ALL. This takes effect the next time the list of queue messages is retrieved or refreshed.
Parameters:
selection - The selection. Valid values are:
Throws:
java.beans.PropertyVetoException - If the change is vetoed.
See Also:
RMessageQueue.SELECTION_CRITERIA

setSeverity

public void setSeverity(int severity)
                 throws java.beans.PropertyVetoException
Sets the severity of the messages which are returned. All messages of the specified severity and greater are returned. The default is 0. This takes effect the next time that the list of queued messages is retreived or refreshed.
Parameters:
severity - The severity of the messages to be returned. The value must be between 0 and 99, inclusive.
Throws:
java.beans.PropertyVetoException - If the change is vetoed.
See Also:
RMessageQueue.SEVERITY_CRITERIA

setSystem

public void setSystem(AS400 system)
               throws java.beans.PropertyVetoException
Sets the system. This cannot be changed if the object has established a connection to the AS/400.
Parameters:
system - The system.
Throws:
java.beans.PropertyVetoException - If the property change is vetoed.