AS400Message

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

QueuedMessage
```
public class AS400Message
extends java.lang.Object
implements java.io.Serializable
```
Represents a message returned from an IBM i system. A Java program does not normally create AS400Message objects directly. Instead, AS400Message objects are created and returned by various other IBM Toolbox for Java components.
Usage hint: To fully "prime" an AS400Message object with additional information that otherwise might not be returned from the system, call the load() method. For example, if getHelp() returns null, try preceding the getHelp() with a call to load().

See Also:
AS400Exception, CommandCall, ProgramCall, SpooledFile, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`COMPLETION` Message type for completion messages.
`static int`	`DIAGNOSTIC` Message type for diagnostic messages.
`static int`	`ESCAPE` Message type for escape (exception already handled when API is called) messages.
`static int`	`ESCAPE_NOT_HANDLED` Message type for escape (exception not handled when API is called) messages.
`static int`	`INFORMATIONAL` Message type for informational messages.
`static int`	`INQUIRY` Message type for inquiry messages.
`static int`	`MESSAGE_OPTION_ALL` Constant for the option indicating all the messages should be returned.
`static int`	`MESSAGE_OPTION_NONE` Constant for the option indicating that no messages should be returned.
`static int`	`MESSAGE_OPTION_UP_TO_10` Constant for the option indicating up to ten messages sent to the caller should be returned.
`static int`	`NOTIFY` Message type for notify (exception already handled when API is called) messages.
`static int`	`NOTIFY_NOT_HANDLED` Message type for notify (exception not handled when API is called) messages.
`static int`	`REPLY_FROM_SYSTEM_REPLY_LIST` Message type for reply, from system reply list messages.
`static int`	`REPLY_MESSAGE_DEFAULT_USED` Message type for reply, message default used messages.
`static int`	`REPLY_NOT_VALIDITY_CHECKED` Message type for reply, not validity checked messages.
`static int`	`REPLY_SYSTEM_DEFAULT_USED` Message type for reply, system default used messages.
`static int`	`REPLY_VALIDITY_CHECKED` Message type for reply, validity checked messages.
`static int`	`REQUEST` Message type for request messages.
`static int`	`REQUEST_WITH_PROMPTING` Message type for request with prompting messages.
`static int`	`SENDERS_COPY` Message type for sender's copy messages.

Method Summary

Methods
Modifier and Type	Method and Description
`java.util.Date`	`getCreateDate()` Returns the messages create date
`java.util.Calendar`	`getDate()` Returns the date and time the message was sent.
`java.lang.String`	`getDefaultReply()` Returns the default reply.
`java.lang.String`	`getFileName()` Returns the message file name.
`java.lang.String`	`getHelp()` Returns the message help.
`java.lang.String`	`getID()` Returns the message ID.
`java.lang.String`	`getLibraryName()` Returns the message file library.
`java.util.Date`	`getModificationDate()` Returns the messages last modification date
`java.lang.String`	`getPath()` Returns the full integrated file system path name of the message file.
`int`	`getSeverity()` Returns the message severity.
`byte[]`	`getSubstitutionData()` Returns the substitution data.
`java.lang.String`	`getText()` Returns the message text with the substitution text inserted.
`int`	`getType()` Returns the message type.
`void`	`load()` Loads additional message information from the system.
`void`	`load(int helpTextFormatting)` Loads additional message information from the system.
`void`	`setCreateDate(java.util.Date createDate_)` Sets the messages create date
`void`	`setModificationDate(java.util.Date modificationDate_)` Sets the messages last modification date
`java.lang.String`	`toString()` Returns the message ID and message text.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - COMPLETION
```
public static final int COMPLETION
```
    Message type for completion messages.
    
    See Also:
    Constant Field Values
  - DIAGNOSTIC
```
public static final int DIAGNOSTIC
```
    Message type for diagnostic messages.
    
    See Also:
    Constant Field Values
  - INFORMATIONAL
```
public static final int INFORMATIONAL
```
    Message type for informational messages.
    
    See Also:
    Constant Field Values
  - INQUIRY
```
public static final int INQUIRY
```
    Message type for inquiry messages.
    
    See Also:
    Constant Field Values
  - SENDERS_COPY
```
public static final int SENDERS_COPY
```
    Message type for sender's copy messages.
    
    See Also:
    Constant Field Values
  - REQUEST
```
public static final int REQUEST
```
    Message type for request messages.
    
    See Also:
    Constant Field Values
  - REQUEST_WITH_PROMPTING
```
public static final int REQUEST_WITH_PROMPTING
```
    Message type for request with prompting messages.
    
    See Also:
    Constant Field Values
  - NOTIFY
```
public static final int NOTIFY
```
    Message type for notify (exception already handled when API is called) messages.
    
    See Also:
    Constant Field Values
  - ESCAPE
```
public static final int ESCAPE
```
    Message type for escape (exception already handled when API is called) messages.
    
    See Also:
    Constant Field Values
  - NOTIFY_NOT_HANDLED
```
public static final int NOTIFY_NOT_HANDLED
```
    Message type for notify (exception not handled when API is called) messages.
    
    See Also:
    Constant Field Values
  - ESCAPE_NOT_HANDLED
```
public static final int ESCAPE_NOT_HANDLED
```
    Message type for escape (exception not handled when API is called) messages.
    
    See Also:
    Constant Field Values
  - REPLY_NOT_VALIDITY_CHECKED
```
public static final int REPLY_NOT_VALIDITY_CHECKED
```
    Message type for reply, not validity checked messages.
    
    See Also:
    Constant Field Values
  - REPLY_VALIDITY_CHECKED
```
public static final int REPLY_VALIDITY_CHECKED
```
    Message type for reply, validity checked messages.
    
    See Also:
    Constant Field Values
  - REPLY_MESSAGE_DEFAULT_USED
```
public static final int REPLY_MESSAGE_DEFAULT_USED
```
    Message type for reply, message default used messages.
    
    See Also:
    Constant Field Values
  - REPLY_SYSTEM_DEFAULT_USED
```
public static final int REPLY_SYSTEM_DEFAULT_USED
```
    Message type for reply, system default used messages.
    
    See Also:
    Constant Field Values
  - REPLY_FROM_SYSTEM_REPLY_LIST
```
public static final int REPLY_FROM_SYSTEM_REPLY_LIST
```
    Message type for reply, from system reply list messages.
    
    See Also:
    Constant Field Values
  - MESSAGE_OPTION_UP_TO_10
```
public static final int MESSAGE_OPTION_UP_TO_10
```
    Constant for the option indicating up to ten messages sent to the caller should be returned. For compatibility, this option is the default. Only messages sent to the caller will be returned, messages sent by the invoked procedure to itself will not be returned.
    
    See Also:
    Constant Field Values
  - MESSAGE_OPTION_NONE
```
public static final int MESSAGE_OPTION_NONE
```
    Constant for the option indicating that no messages should be returned.
    
    See Also:
    Constant Field Values
  - MESSAGE_OPTION_ALL
```
public static final int MESSAGE_OPTION_ALL
```
    Constant for the option indicating all the messages should be returned. All messages sent from invocation beginning to invocation end will be returned. Systems not supporting this new option will revert to the behavior specified for option MESSAGE_OPTION_UP_TO_10.
    
    See Also:
    Constant Field Values
- Method Detail
  - getDate
```
public java.util.Calendar getDate()
```
    Returns the date and time the message was sent. The returned Calendar object will have the following fields set:
    - Calendar.YEAR
    - Calendar.MONTH
    - Calendar.DAY_OF_MONTH
    - Calendar.HOUR
    - Calendar.MINUTE
    - Calendar.SECOND
    Returns:
    The date and time the message was sent, or null if not applicable.
  - getDefaultReply
```
public java.lang.String getDefaultReply()
```
    Returns the default reply.
    
    Returns:
    The default reply, or null if it is not set.
  - getFileName
```
public java.lang.String getFileName()
```
    Returns the message file name.
    
    Returns:
    The message file name, or null if it is not set.
  - getHelp
```
public java.lang.String getHelp()
```
    Returns the message help.
    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.
    Usage hint: If getHelp() returns null, try "priming" the AS400Message object by first calling load(), then getHelp().
    Returns:
    The message help, or null if it is not set.
  - getID
```
public java.lang.String getID()
```
    Returns the message ID.
    
    Returns:
    The message ID, or null if it is not set.
  - getLibraryName
```
public java.lang.String getLibraryName()
```
    Returns the message file library.
    
    Returns:
    The message file library, or null if it is not set.
  - getPath
```
public java.lang.String getPath()
```
    Returns the full integrated file system path name of the message file.
    
    Returns:
    The full integrated file system path name of the message file name, or null if it is not set.
  - getSeverity
```
public int getSeverity()
```
    Returns the message severity.
    
    Returns:
    The message severity. Valid values are between 0 and 99, or -1 if it is not set.
  - getSubstitutionData
```
public byte[] getSubstitutionData()
```
    Returns the substitution data. This is unconverted data used to fill in the replacement characters in the message. To convert the data to something useful, see the CharConverter class for String conversions (CHAR fields) and the BinaryConverter class for integer (BIN fields) and other numeric conversions.
    
    Returns:
    The subsitution data, or null if not set.
  - getText
```
public java.lang.String getText()
```
    Returns the message text with the substitution text inserted.
    
    Returns:
    The message text, or null if it is not set.
  - getType
```
public int getType()
```
    Returns the message type.
    Returns:
    The message type, or negative one (-1) if it is not set. Valid values are:
    
    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
  - load
```
public void load()
          throws AS400SecurityException,
                 ErrorCompletingRequestException,
                 java.io.IOException,
                 java.lang.InterruptedException,
                 ObjectDoesNotExistException
```
    Loads additional message information from the system. If this message does not have an associated message file, this method does nothing.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    
    java.io.IOException - If an error occurs while communicating with the system.
    
    java.lang.InterruptedException - If this thread is interrupted.
    
    ObjectDoesNotExistException - If the system object does not exist.
  - load
```
public void load(int helpTextFormatting)
          throws AS400SecurityException,
                 ErrorCompletingRequestException,
                 java.io.IOException,
                 java.lang.InterruptedException,
                 ObjectDoesNotExistException
```
    Loads additional message information from the system. If this message does not have an associated message file, this method does nothing.
    
    Parameters:
    helpTextFormatting - Formatting performed on the help text. Valid values for this parameter are NO_FORMATTING, RETURN_FORMATTING_CHARACTERS, and SUBSTITUTE_FORMATTING_CHARACTERS.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    
    java.io.IOException - If an error occurs while communicating with the system.
    
    java.lang.InterruptedException - If this thread is interrupted.
    
    ObjectDoesNotExistException - If the system object does not exist.
  - toString
```
public java.lang.String toString()
```
    Returns the message ID and message text.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    The message ID and message text.
  - getCreateDate
```
public java.util.Date getCreateDate()
```
    Returns the messages create date
    
    Returns:
    the createDate_
  - setCreateDate
```
public void setCreateDate(java.util.Date createDate_)
```
    Sets the messages create date
    
    Parameters:
    createDate_ - the createDate_ to set
  - getModificationDate
```
public java.util.Date getModificationDate()
```
    Returns the messages last modification date
    
    Returns:
    the modificationDate_
  - setModificationDate
```
public void setModificationDate(java.util.Date modificationDate_)
```
    Sets the messages last modification date
    
    Parameters:
    modificationDate_ - the modificationDate_ to set

Methods inherited from class java.lang.Object

COMPLETION

DIAGNOSTIC

INFORMATIONAL

INQUIRY

SENDERS_COPY

REQUEST

REQUEST_WITH_PROMPTING

NOTIFY

ESCAPE

NOTIFY_NOT_HANDLED

ESCAPE_NOT_HANDLED

REPLY_NOT_VALIDITY_CHECKED

REPLY_VALIDITY_CHECKED

REPLY_MESSAGE_DEFAULT_USED

REPLY_SYSTEM_DEFAULT_USED

REPLY_FROM_SYSTEM_REPLY_LIST

MESSAGE_OPTION_UP_TO_10

MESSAGE_OPTION_NONE

MESSAGE_OPTION_ALL

getDate

getDefaultReply

getFileName

getHelp

getID

getLibraryName

getPath

getSeverity

getSubstitutionData

getText

getType

load

load

toString

getCreateDate

setCreateDate

getModificationDate

setModificationDate