Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.comm
Class ListServiceProgramInformation

java.lang.Object
  extended by com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor
      extended by com.ibm.etools.iseries.comm.ListServiceProgramInformation
All Implemented Interfaces:
IISeriesAPIProcessor

public class ListServiceProgramInformation
extends ISeriesAbstractHostAPIProcessor

ListServiceProgramInformation is a JavaBean wrapper for the OS/400 List Service Program Information (QBNLSPGM)> system API. The List Service Program Information API gives information about service programs, similar to the Display Service Program (DSPSRVPGM) command.

This wrapper currently only supports retrieving a module list of the service program using the SPGL0100 format.


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
ListServiceProgramInformation()
          Constructor to use when you do not already have an AS400 object.
ListServiceProgramInformation(AS400 system)
          Constructor
 
Method Summary
 List retrieveModuleList(String library, String name)
          Retrieve a list of modules for the service program and information about each module.
 
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

ListServiceProgramInformation

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


ListServiceProgramInformation

public ListServiceProgramInformation(AS400 system)
Constructor

Parameters:
system - AS400 Toolbox object used to connect to the iSeries
Method Detail

retrieveModuleList

public List retrieveModuleList(String library,
                               String name)
                        throws Exception
Retrieve a list of modules for the service program and information about each module.

Parameters:
library - Name of the library for the service program.
name - Name of the service program.
Returns:
A list of modules in the service program. Each object in the list is an instance of IISeriesHostModule
Throws:
ISeriesAPIErrorCodeException - If an error occurs while the host api is running.
IBM - Toolbox for Java exceptions if an error occurs while calling the host api.
Exception
See Also:
IISeriesHostModule

Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.