com.ibm.etools.iseries.comm
Class ListModuleInformation

java.lang.Object
  com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor
      com.ibm.etools.iseries.comm.ListModuleInformation

All Implemented Interfaces:

IISeriesAPIProcessor

public class ListModuleInformation
extends ISeriesAbstractHostAPIProcessor

ListModuleInformation is a Java wrapper for the OS/400 List Module Information (QBNLMODI) system API. Currently only the MODL0300 format is supported for retrieving a list of procedures in the module (retrieveProcedureList).

Nested Class Summary

Nested classes/interfaces inherited from class com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor

ISeriesAbstractHostAPIProcessor.HostAPIErrorCodeStructure

Field Summary

static String

Copyright

Fields inherited from class com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor

cancel, cancellableSubTasks, cancelQuerier, CREATE_FALSE, CREATE_TRUE, dbcsConvert, DEFAULT_OBJECT_FACTORY_BASIC, DEFAULT_OBJECT_FACTORY_BRIEF, DEFAULT_OBJECT_FACTORY_EXHAUSTIVE, DEFAULT_OBJECT_FACTORY_NAMEONLY, errorcodeObj, hostAPILibraries, INFOLEVEL_BASIC, INFOLEVEL_BRIEF, INFOLEVEL_EXHAUSTIVE, INFOLEVEL_NAME, INFOLEVEL_NAMEARRAY, INITIAL_SPACESIZE, LOG_DIR, LOG_FILENAME, logFile, logFileStream, logLineCounter, logStandardOut, NEED_USERSPACE_NO, NEED_USERSPACE_YES, objName, objType, QVDEOBJLinfo, returnObjectFactory, todos, tracePrefix, warnings

Constructor Summary

ListModuleInformation()
Constructor to use when you do not already have an AS400 object.

ListModuleInformation(AS400 system)
Constructor

Method Summary

List	retrieveProcedureList(String library, String name) Retrieve a list of procedures for the module and information about each procedure.

Methods inherited from class com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor

addCancellableSubTask, addWarning, cancel, clearWarnings, closeUserSpace, computeSize, createUserSpaceOnHost, determineInfoLevel, getClientCCSID, getDefaultObjectFactory, getErrorCodeStructure, getHostCCSID, getLibrary, getLogFileStream, getObjectFactory, getObjectName, getObjectType, getSystem, getUserSpace, getUserSpaceAPIName, getUserSpaceIFSName, getUserSpaceLibrary, getUserSpaceName, getWarnings, isCancelled, isTraceOn, logException, logHostMessages, logMessage, logMessage, logMessage, logTodo, openUserSpace, padString, parseBin8Date, parseChar13Date, parseChar7Date, parseChar8Date, readUserSpace, readUserSpace, registerCancelQuerier, removeCancellableSubTask, setClientCCSID, setHostCCSID, setLibrary, setLogFileDirectory, setObjectFactory, setObjectName, setObjectType, setSystem, setTracing, setUserSpaceLibrary, setUserSpaceName

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

ListModuleInformation

public ListModuleInformation()

Constructor to use when you do not already have an AS400 object. A new AS400 object will be created when retrieveProcedureList is called, unless you subsequently call setSystem(AS400) first.

ListModuleInformation

public ListModuleInformation(AS400 system)

Constructor

Parameters:

system - AS400 object used to connect to the iSeries

Method Detail

retrieveProcedureList

public List retrieveProcedureList(String library,
                                  String name)
                           throws Exception

Retrieve a list of procedures for the module and information about each procedure.

Parameters:

library - Name of the library where the module exists.

name - Name of the module

Returns:

List A list of procedures in the specified module. Each procedure in the list is an instance of IISeriesHostProcedure

Throws:

Exception

See Also:

IISeriesHostProcedure