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:
- CommandCall and ProgramCall will return non-null values for the following:
- File name
- ID
- Library name
- Path
- Severity
- Substitution data
- Text
- Type
- DataQueue and KeyedDataQueue will return non-null values for the following:
- Record-level access classes will return non-null values for the following:
- SpooledFile will return non-null values for the following:
- Date
- Help
- ID
- Reply
- Severity
- Text
- Type
-
COMPLETION
- Message type for completion messages.
-
DIAGNOSTIC
- Message type for diagnostic messages.
-
ESCAPE
- Message type for escape messages.
-
INFORMATIONAL
- Message type for informational messages.
-
INQUIRY
- Message type for inquiry messages.
-
NOTIFY
- Message type for notify messages.
-
REPLY_FROM_SYSTEM_REPLY_LIST
- Message type for reply, from system reply list messages.
-
REPLY_MESSAGE_DEFAULT_USED
- Message type for reply, message default used messages.
-
REPLY_NOT_VALIDITY_CHECKED
- Message type for reply, not validity checked messages.
-
REPLY_SYSTEM_DEFAULT_USED
- Message type for reply, system default used messages.
-
REPLY_VALIDITY_CHECKED
- Message type for reply, validity checked messages.
-
REQUEST_COPY
- Message type for request messages.
-
REQUEST_WITH_PROMPTING
- Message type for request with prompting messages.
-
SENDERS_COPY
- Message type for sender's copy messages.
-
getDate()
- Returns the date and time the message was issued.
-
getDefaultReply()
- Returns the default reply for the message.
-
getFileName()
- Returns the message file name.
-
getHelp()
- Returns any message help text.
-
getID()
- Returns the ID for the message.
-
getLibraryName()
- Returns the message library name.
-
getPath()
- Returns the full integrated file system path name of the
message file containing the message.
-
getSeverity()
- Returns the message severity.
-
getSubstitutionData()
- Returns the message substitution text.
-
getText()
- Returns the message text.
-
getType()
- Returns the message type.
-
toString()
- Returns a short description of the object.
COMPLETION
public static final int COMPLETION
- Message type for completion messages.
DIAGNOSTIC
public static final int DIAGNOSTIC
- Message type for diagnostic messages.
INFORMATIONAL
public static final int INFORMATIONAL
- Message type for informational messages.
INQUIRY
public static final int INQUIRY
- Message type for inquiry messages.
SENDERS_COPY
public static final int SENDERS_COPY
- Message type for sender's copy messages.
REQUEST_COPY
public static final int REQUEST_COPY
- Message type for request messages.
REQUEST_WITH_PROMPTING
public static final int REQUEST_WITH_PROMPTING
- Message type for request with prompting messages.
NOTIFY
public static final int NOTIFY
- Message type for notify messages.
ESCAPE
public static final int ESCAPE
- Message type for escape messages.
REPLY_NOT_VALIDITY_CHECKED
public static final int REPLY_NOT_VALIDITY_CHECKED
- Message type for reply, not validity checked messages.
REPLY_VALIDITY_CHECKED
public static final int REPLY_VALIDITY_CHECKED
- Message type for reply, validity checked messages.
REPLY_MESSAGE_DEFAULT_USED
public static final int REPLY_MESSAGE_DEFAULT_USED
- Message type for reply, message default used messages.
REPLY_SYSTEM_DEFAULT_USED
public static final int REPLY_SYSTEM_DEFAULT_USED
- Message type for reply, system default used messages.
REPLY_FROM_SYSTEM_REPLY_LIST
public static final int REPLY_FROM_SYSTEM_REPLY_LIST
- Message type for reply, from system reply list messages.
getDate
public Calendar getDate()
- Returns the date and time the message was issued.
If not set, null will be returned.
The valid fields are :
- Calendar.YEAR
- Calendar.MONTH
- Calendar.DAY_OF_MONTH
- Calendar.HOUR
- Calendar.MINUTE
- Calendar.SECOND
- Returns:
- The date and time the message was issued.
If not set, null will be returned.
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.
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.
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:
- &N - Force the text to a new line indented to column 2. If the text
is longer than 1 line, the next lines should be indented to
column 4 until the end of the text or another format control
character is found.
- &P - Force the text to a new line indented to column 6. If the
text is longer than 1 line, the next lines should start in
column 4 until the end of the text or another format control
character is found.
- &B - Force the text to a new line starting in column 4. If the
text is longer than 1 line, the next lines should start in
column 6 until the end of the text or another format control
character is found.
- Returns:
- The message help text. If not set, null will be returned.
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.
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.
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.
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.
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.
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.
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.
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