|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.as400.access.AS400Message
The AS400Message class represents a message returned from an AS/400. A Java program does not normally create AS400Message objects directly. Instead, AS400Message objects are created and returned by various other AS/400 Toolbox for Java components.
Usage hint: To fully "prime" an AS400Message object with additional information that otherwise might not be returned from the AS/400, call the load() method. For example, if getHelp() returns null, try preceding the getHelp() with a call to load().
AS400Exception
,
CommandCall
,
ProgramCall
,
SpooledFile
, Serialized FormField Summary | |
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 |
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 | |
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.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 AS/400. |
void |
load(int helpTextFormatting)
Loads additional message information from AS/400. |
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 |
public static final int COMPLETION
public static final int DIAGNOSTIC
public static final int INFORMATIONAL
public static final int INQUIRY
public static final int SENDERS_COPY
public static final int REQUEST
public static final int REQUEST_WITH_PROMPTING
public static final int NOTIFY
public static final int ESCAPE
public static final int NOTIFY_NOT_HANDLED
public static final int ESCAPE_NOT_HANDLED
public static final int REPLY_NOT_VALIDITY_CHECKED
public static final int REPLY_VALIDITY_CHECKED
public static final int REPLY_MESSAGE_DEFAULT_USED
public static final int REPLY_SYSTEM_DEFAULT_USED
public static final int REPLY_FROM_SYSTEM_REPLY_LIST
Method Detail |
public java.util.Calendar getDate()
public java.lang.String getDefaultReply()
public java.lang.String getFileName()
public java.lang.String getHelp()
Message formatting characters may appear in the message help and are defined as follows:
public java.lang.String getID()
public java.lang.String getLibraryName()
public java.lang.String getPath()
public int getSeverity()
public byte[] getSubstitutionData()
public java.lang.String getText()
public int getType()
public void load() throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, java.lang.InterruptedException, ObjectDoesNotExistException
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 AS/400.java.lang.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the AS/400 object does not exist.public void load(int helpTextFormatting) throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, java.lang.InterruptedException, ObjectDoesNotExistException
helpTextFormatting
- Formatting performed on the help text. Valid
values for this parameter are defined in the MessageFile
class. They are no formatting, return formatting characters,
and replace (substitute) formatting characters.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 AS/400.java.lang.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the AS/400 object does not exist.public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |