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:


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.

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.
  • 1 : Completion
  • 2 : Diagnostic
  • 4 : Informational
  • 5 : Inquiry
  • 6 : Sender's copy
  • 8 : Request
  • 10 : Request with prompting
  • 14 : Notify
  • 15 : Escape
  • 21 : Reply, not validity checked
  • 22 : Reply, validity checked
  • 23 : Reply, message default used
  • 24 : Reply, system default used
  • 25 : 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