|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.as400.access.AS400Message
public class AS400Message
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().
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 |
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 | |
---|---|
Date |
getCreateDate()
Returns the messages create date |
Calendar |
getDate()
Returns the date and time the message was sent. |
String |
getDefaultReply()
Returns the default reply. |
String |
getFileName()
Returns the message file name. |
String |
getHelp()
Returns the message help. |
String |
getID()
Returns the message ID. |
String |
getLibraryName()
Returns the message file library. |
Date |
getModificationDate()
Returns the messages last modification date |
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. |
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(Date createDate_)
Sets the messages create date |
void |
setModificationDate(Date modificationDate_)
Sets the messages last modification date |
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
public static final int MESSAGE_OPTION_UP_TO_10
public static final int MESSAGE_OPTION_NONE
public static final int MESSAGE_OPTION_ALL
Method Detail |
---|
public Calendar getDate()
public String getDefaultReply()
public String getFileName()
public String getHelp()
Message formatting characters may appear in the message help and are defined as follows:
public String getID()
public String getLibraryName()
public String getPath()
public int getSeverity()
public byte[] getSubstitutionData()
CharConverter
class for String conversions (CHAR fields) and the BinaryConverter
class for integer (BIN fields) and other numeric conversions.
public String getText()
public int getType()
public void load() throws AS400SecurityException, ErrorCompletingRequestException, IOException, InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
IOException
- If an error occurs while communicating with the system.
InterruptedException
- If this thread is interrupted.
ObjectDoesNotExistException
- If the system object does not exist.public void load(int helpTextFormatting) throws AS400SecurityException, ErrorCompletingRequestException, IOException, InterruptedException, ObjectDoesNotExistException
helpTextFormatting
- Formatting performed on the help text. Valid values for this parameter are NO_FORMATTING
, RETURN_FORMATTING_CHARACTERS
, and SUBSTITUTE_FORMATTING_CHARACTERS
.
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
IOException
- If an error occurs while communicating with the system.
InterruptedException
- If this thread is interrupted.
ObjectDoesNotExistException
- If the system object does not exist.public String toString()
toString
in class Object
public Date getCreateDate()
public void setCreateDate(Date createDate_)
createDate_
- the createDate_ to setpublic Date getModificationDate()
public void setModificationDate(Date modificationDate_)
modificationDate_
- the modificationDate_ to set
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |