com.ibm.etools.iseries.services.qsys.objects
Class RetrieveMessageAPIWrapper

java.lang.Object
  com.ibm.etools.iseries.services.qsys.objects.RetrieveMessageAPIWrapper

public class RetrieveMessageAPIWrapper
extends Object

Java class to wrapper the QMHRTVM IBM i API for retrieving message descriptions.

Field Summary

static String

copyright

Constructor Summary

RetrieveMessageAPIWrapper(AS400 as400, IQSYSMessageFile file, IQSYSFactory factory)
Constructor for ApiQMHRTVM.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

copyright

public static String copyright

Constructor Detail

RetrieveMessageAPIWrapper

public RetrieveMessageAPIWrapper(AS400 as400,
                                 IQSYSMessageFile file,
                                 IQSYSFactory factory)

Constructor for ApiQMHRTVM.

Method Detail

getFirstMessage

public IQSYSMessageDescription getFirstMessage()
                                        throws Exception

Throws:

Exception

getNextMessage

public IQSYSMessageDescription getNextMessage()
                                       throws Exception

Throws:

Exception

getMessage

public IQSYSMessageDescription getMessage(String id)
                                   throws Exception

Throws:

Exception

getMessageWithReplacement

public IQSYSMessageDescription getMessageWithReplacement(String id,
                                                         String replacement)
                                                  throws Exception

Parameters:

id -

replacement -

Returns:

ISeriesMessageDescriptor with the first level message containing the replacement text

Throws:

Exception