All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.access.AS400Message

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

public class AS400Message
extends Object
implements Serializable
The AS400Message class represents a message returned from an AS/400. The various get methods may return a null value depending upon the class that did the original AS400Message creation. For example:


Variable Index

 o COMPLETION
Message type for completion messages.
 o DIAGNOSTIC
Message type for diagnostic messages.
 o ESCAPE
Message type for escape messages.
 o INFORMATIONAL
Message type for informational messages.
 o INQUIRY
Message type for inquiry messages.
 o NOTIFY
Message type for notify messages.
 o REPLY_FROM_SYSTEM_REPLY_LIST
Message type for reply, from system reply list messages.
 o REPLY_MESSAGE_DEFAULT_USED
Message type for reply, message default used messages.
 o REPLY_NOT_VALIDITY_CHECKED
Message type for reply, not validity checked messages.
 o REPLY_SYSTEM_DEFAULT_USED
Message type for reply, system default used messages.
 o REPLY_VALIDITY_CHECKED
Message type for reply, validity checked messages.
 o REQUEST_COPY
Message type for request messages.
 o REQUEST_WITH_PROMPTING
Message type for request with prompting messages.
 o SENDERS_COPY
Message type for sender's copy messages.

Method Index

 o getDate()
Returns the date and time the message was issued.
 o getDefaultReply()
Returns the default reply for the message.
 o getFileName()
Returns the message file name.
 o getHelp()
Returns any message help text.
 o getID()
Returns the ID for the message.
 o getLibraryName()
Returns the message library name.
 o getPath()
Returns the full integrated file system path name of the message file containing the message.
 o getSeverity()
Returns the message severity.
 o getSubstitutionData()
Returns the message substitution text.
 o getText()
Returns the message text.
 o getType()
Returns the message type.
 o toString()
Returns a short description of the object.

Variables

 o COMPLETION
 public static final int COMPLETION
Message type for completion messages.

 o DIAGNOSTIC
 public static final int DIAGNOSTIC
Message type for diagnostic messages.

 o INFORMATIONAL
 public static final int INFORMATIONAL
Message type for informational messages.

 o INQUIRY
 public static final int INQUIRY
Message type for inquiry messages.

 o SENDERS_COPY
 public static final int SENDERS_COPY
Message type for sender's copy messages.

 o REQUEST_COPY
 public static final int REQUEST_COPY
Message type for request messages.

 o REQUEST_WITH_PROMPTING
 public static final int REQUEST_WITH_PROMPTING
Message type for request with prompting messages.

 o NOTIFY
 public static final int NOTIFY
Message type for notify messages.

 o ESCAPE
 public static final int ESCAPE
Message type for escape messages.

 o REPLY_NOT_VALIDITY_CHECKED
 public static final int REPLY_NOT_VALIDITY_CHECKED
Message type for reply, not validity checked messages.

 o REPLY_VALIDITY_CHECKED
 public static final int REPLY_VALIDITY_CHECKED
Message type for reply, validity checked messages.

 o REPLY_MESSAGE_DEFAULT_USED
 public static final int REPLY_MESSAGE_DEFAULT_USED
Message type for reply, message default used messages.

 o REPLY_SYSTEM_DEFAULT_USED
 public static final int REPLY_SYSTEM_DEFAULT_USED
Message type for reply, system default used messages.

 o REPLY_FROM_SYSTEM_REPLY_LIST
 public static final int REPLY_FROM_SYSTEM_REPLY_LIST
Message type for reply, from system reply list messages.

Methods

 o getDate
 public Calendar getDate()
Returns the date and time the message was issued. If not set, null will be returned. The valid fields are :

Returns:
The date and time the message was issued. If not set, null will be returned.
 o getDefaultReply
 public String getDefaultReply()
Returns the default reply for the message. If not set, null will be returned.

Returns:
The default reply for the message. If not set, null will be returned.
 o getFileName
 public String getFileName()
Returns the message file name. This is the AS/400 file containing the message. If not set, null will be returned.

Returns:
The message file name. If not set, null will be returned.
 o getHelp
 public String getHelp()
Returns any message help text. If not set, null will be returned. Message formatting characters may appear in the message help and are defined as follows:

Returns:
The message help text. If not set, null will be returned.
 o getID
 public String getID()
Returns the ID for the message. If not set, null will be returned.

Returns:
The ID for the message. If not set, null will be returned.
 o getLibraryName
 public String getLibraryName()
Returns the message library name. This is the AS/400 library containing the file and message. If not set, null will be returned.

Returns:
The message library name. If not set, null will be returned.
 o getPath
 public String getPath()
Returns the full integrated file system path name of the message file containing the message.

Returns:
The fully-qualified message file name. If not set, null will be returned.
 o getSeverity
 public int getSeverity()
Returns the message severity. Severity is between 0 and 99. If not set, negative one (-1) will be returned.

Returns:
The message severity. If not set, negative one (-1) will be returned.
 o getSubstitutionData
 public byte[] getSubstitutionData()
Returns the message substitution text. This is the unconverted data used to fill in the replacement characters in the message. If not set, null will be returned.

Returns:
The substitution text. If not set, null will be returned.
 o getText
 public String getText()
Returns the message text. The substitution text has already been inserted. If not set, null will be returned.

Returns:
The message text. If not set, null will be returned.
 o getType
 public int getType()
Returns the message type. If not set, null will be returned.

Returns:
The message type.
  • COMPLETION
  • DIAGNOSTIC
  • INFORMATIONAL
  • INQUIRY
  • SENDERS_COPY
  • REQUEST
  • REQUEST_WITH_PROMPTING
  • NOTIFY
  • ESCAPE
  • REPLY_NOT_VALIDITY_CHECKED
  • REPLY_VALIDITY_CHECKED
  • REPLY_MESSAGE_DEFAULT_USED
  • REPLY_SYSTEM_DEFAULT_USED
  • REPLY_FROM_SYSTEM_REPLY_LIST
If not set, null will be returned.
 o toString
 public String toString()
Returns a short description of the object.

Returns:
The String ID and text of the AS400 message.
Overrides:
toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index