Serializable
QueuedMessage
public class AS400Message extends Object implements Serializable
AS400Exception
,
CommandCall
,
ProgramCall
,
SpooledFile
,
Serialized FormModifier and Type | Field | 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.
|
Modifier and Type | Method | Description |
---|---|---|
boolean |
equals(Object o) |
|
String |
getAlertOption() |
Get the alert option
Whether and when an SNA alert is created and sent for the message.
|
Date |
getCreateDate() |
Returns the messages create date
|
int |
getDataCcsidConversionStatusIndicator() |
Get the data ccsid conversion status indicator.
|
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.
|
byte[] |
getKey() |
Returns the 4-byte message key..
|
String |
getLibraryName() |
Returns the message file library.
|
String |
getMessageFileLibrarySpecified() |
Get the message file library specified.
|
Date |
getModificationDate() |
Returns the messages last modification date
|
String |
getPath() |
Returns the full integrated file system path name of the message file.
|
String |
getReceivingProgramInstructionNumber() |
Get the receiving program instruction number.
|
String |
getReceivingProgramName() |
Get the receiving program name.
|
String |
getReceivingType() |
Get the type of the receiver (whether it is a program or procedure).
|
String |
getSendingProgramInstructionNumber() |
Get the sending program instruction number.
|
String |
getSendingProgramName() |
Get the sending program name.
|
String |
getSendingType() |
Get the type of the sender (whether it is a program or procedure).
|
int |
getSeverity() |
Returns the message severity.
|
byte[] |
getSubstitutionData() |
Returns the substitution data.
|
String |
getText() |
Returns the message text with the substitution text inserted.
|
int |
getTextCcsidConversionStatusIndicator() |
Get the text ccsid conversion status indicator.
|
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 |
setAlertOption(String alertOption) |
set the alert option
|
void |
setCreateDate(Date createDate_) |
Sets the messages create date
|
void |
setDataCcsidConversionStatusIndicator(int conversionStatusIndicator) |
set the data ccsid conversion status indicator.
|
void |
setKey(byte[] key) |
Set the message key.
|
void |
setMessageFileLibrarySpecified(String library) |
Set the MessageFileLibrarySpecified.
|
void |
setModificationDate(Date modificationDate_) |
Sets the messages last modification date
|
void |
setReceivingProgramInstructionNumber(String instructionNumber) |
set the receiving program instruction number
|
void |
setReceivingProgramName(String programName) |
Set the receiving program name.
|
void |
setReceivingType(String receivingType) |
set the receiving type
|
void |
setSendingProgramInstructionNumber(String instructionNumber) |
Set the sending program instruction number.
|
void |
setSendingProgramName(String programName) |
Set the sending program name
|
void |
setSendingType(String sendingType) |
Set the sending type of the program
|
void |
setTextCcsidConversionStatusIndicator(int conversionStatusIndicator) |
set the text ccsid conversion status indicator.
|
String |
toString() |
Returns the message ID and message text.
|
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
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()
public Date getCreateDate()
public void setCreateDate(Date createDate_)
createDate_
- the createDate_ to setpublic Date getModificationDate()
public void setModificationDate(Date modificationDate_)
modificationDate_
- the modificationDate_ to setpublic void setKey(byte[] key)
key
- public byte[] getKey()
public void setMessageFileLibrarySpecified(String library)
library
- public String getMessageFileLibrarySpecified()
public void setSendingProgramName(String programName)
programName
- public String getSendingProgramName()
public void setSendingProgramInstructionNumber(String instructionNumber)
instructionNumber
- public String getSendingProgramInstructionNumber()
public void setReceivingProgramName(String programName)
programName
- public String getReceivingProgramName()
public void setReceivingProgramInstructionNumber(String instructionNumber)
instructionNumber
- public String getReceivingProgramInstructionNumber()
public void setSendingType(String sendingType)
sendingType
- public String getSendingType()
public void setReceivingType(String receivingType)
receivingType
- public String getReceivingType()
public void setTextCcsidConversionStatusIndicator(int conversionStatusIndicator)
conversionStatusIndicator
- public int getTextCcsidConversionStatusIndicator()
public void setDataCcsidConversionStatusIndicator(int conversionStatusIndicator)
conversionStatusIndicator
- public int getDataCcsidConversionStatusIndicator()
public void setAlertOption(String alertOption)
alertOption
- public String getAlertOption()
Copyright © 2024. All rights reserved.