|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.as400.access.AS400Message | +--com.ibm.as400.access.QueuedMessage
The QueuedMessage class represents a message on an AS/400 message queue or job log.
Some of the attributes have associated get methods
defined in this class. These are provided for backwards compatibility
with previous versions of the AS/400 Toolbox for Java. The complete
set of attribute values can be accessed using the
RQueuedMessage
class.
RQueuedMessage
, Serialized FormFields inherited from class com.ibm.as400.access.AS400Message |
COMPLETION,
DIAGNOSTIC,
ESCAPE,
ESCAPE_NOT_HANDLED,
INFORMATIONAL,
INQUIRY,
NOTIFY,
NOTIFY_NOT_HANDLED,
REPLY_FROM_SYSTEM_REPLY_LIST,
REPLY_MESSAGE_DEFAULT_USED,
REPLY_NOT_VALIDITY_CHECKED,
REPLY_SYSTEM_DEFAULT_USED,
REPLY_VALIDITY_CHECKED,
REQUEST,
REQUEST_WITH_PROMPTING,
SENDERS_COPY |
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 |
getFromJobName()
Returns the sender job name. |
java.lang.String |
getFromJobNumber()
Returns the sender job number. |
java.lang.String |
getFromProgram()
Returns the sending program name. |
java.lang.String |
getHelp()
Returns the message help. |
java.lang.String |
getID()
Returns the message ID. |
byte[] |
getKey()
Returns the message key. |
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. |
MessageQueue |
getQueue()
Returns the message queue. |
java.lang.String |
getReplyStatus()
Returns the reply status. |
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. |
java.lang.String |
getUser()
Returns the sender user name. |
void |
load()
Reloads message help text. |
void |
load(int helpTextFormatting)
Reloads message help text. |
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 |
Method Detail |
public java.util.Calendar getDate()
RQueuedMessage.DATE_SENT
public java.lang.String getDefaultReply()
RQueuedMessage.DEFAULT_REPLY
public java.lang.String getFileName()
RQueuedMessage.MESSAGE_FILE
public java.lang.String getFromProgram()
RQueuedMessage.SENDING_PROGRAM_NAME
public java.lang.String getFromJobName()
RQueuedMessage.SENDER_JOB_NAME
public java.lang.String getFromJobNumber()
RQueuedMessage.SENDER_JOB_NUMBER
public java.lang.String getHelp()
Message formatting characters may appear in the message help and are defined as follows:
RQueuedMessage.MESSAGE_HELP
public java.lang.String getID()
RQueuedMessage.MESSAGE_ID
public byte[] getKey()
RQueuedMessage.MESSAGE_KEY
public java.lang.String getLibraryName()
RQueuedMessage.MESSAGE_FILE
public java.lang.String getPath()
public MessageQueue getQueue()
public java.lang.String getReplyStatus()
RQueuedMessage.REPLY_STATUS
public int getSeverity()
RQueuedMessage.MESSAGE_SEVERITY
public byte[] getSubstitutionData()
RQueuedMessage.SUBSTITUTION_DATA
public java.lang.String getText()
RQueuedMessage.MESSAGE_TEXT
public int getType()
RQueuedMessage.MESSAGE_TYPE
public java.lang.String getUser()
RQueuedMessage.SENDER_USER_NAME
public void load() throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, java.lang.InterruptedException, ObjectDoesNotExistException
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.public java.lang.String toString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |