com.ibm.etools.iseries.subsystems.qsys.api
Class MessageFile

java.lang.Object
  com.ibm.etools.iseries.subsystems.qsys.api.MessageFile

public class MessageFile
extends Object

Class representing an IBM i message file with methods for retrieving messages and substituting values.

Field Summary

static String

Copyright

Constructor Summary

MessageFile(AS400 as400, String libraryName, String fileName)
Constructor for ApiQMHRTVM.

Method Summary

MessageDescriptor	getFirstMessage()
MessageDescriptor	getMessage(String id)
MessageDescriptor	getMessageWithReplacement(String id, String replacement)
MessageDescriptor	getNextMessage()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Copyright

public static final String Copyright

See Also:

Constant Field Values

Constructor Detail

MessageFile

public MessageFile(AS400 as400,
                   String libraryName,
                   String fileName)

Constructor for ApiQMHRTVM.

Method Detail

getFirstMessage

public MessageDescriptor getFirstMessage()

getNextMessage

public MessageDescriptor getNextMessage()

getMessage

public MessageDescriptor getMessage(String id)

getMessageWithReplacement

public MessageDescriptor getMessageWithReplacement(String id,
                                                   String replacement)

Parameters:

id -

replacement -

Returns:

ISeriesMessageDescriptor with the first level message containing the replacement text