Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.comm
Class ISeriesListSpoolFiles

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

public class ISeriesListSpoolFiles
extends ISeriesAbstractHostAPIProcessor
implements IISeriesListProcessor

A class for listing SpoolFiles on an iSeries. This is done by calling the system API QUSLSPL. The NAME-ONLY retrieval is not implemented.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor
ISeriesAbstractHostAPIProcessor.HostAPIErrorCodeStructure
 
Field Summary
static String Copyright
           
static int LIST_BASIC
          Return list with basic information per SpoolFile (IISeriesHostSpoolFileBasic)
static int LIST_NAMES
          Return list of names only.
 
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
ISeriesListSpoolFiles()
          Constructor used when you do not have an AS400 object already.
ISeriesListSpoolFiles(AS400 system)
          Constructor when there is an existing AS400 object.
 
Method Summary
protected  void buildList(int nbrRows, int listStartingPosition, int sizePerRow)
          Build the list.
protected  String getFilterString()
          Return the filter string used for this list request.
protected  ISeriesSplfFilterString getFilterStringObject()
          Return the filter string object used for this list request.
 List getList(ISeriesAbstractFilterString fsObj)
          As per the IISeriesListProcessor interface requirements.
 List getList(ISeriesAbstractFilterString fsObj, IISeriesHostListBaseFactory listSpoolFileFactory)
          Retrieve a list of SpoolFiles, returning objects created by a supplied object factory.
 List getList(ISeriesAbstractFilterString fsObj, IISeriesHostListBaseFactory listSpoolFileFactory, IISeriesHostListStatusCallback callback)
          Retrieve a list of SpoolFiles, informing the caller when processing starts for each part of a multi-generic list.
 List getListBrief(ISeriesAbstractFilterString fsObj)
          As per the IISeriesListProcessor interface requirements.
protected  void getListFromAS400(String filterString)
          Call QUSLRCD on AS/400 to get the list.
 ISeriesListSpoolFilesHeader getListHeader()
          This method returns the SpoolFile list header information.
 List getListNameOnly(ISeriesAbstractFilterString fsObj)
          As per the IISeriesListProcessor interface requirements.
protected  IISeriesHostListSpoolFileFactory getListSpoolFileFactory()
          Get object factory used to create new objects.
 int getListType()
          Retrieve file override value.
 List getSpoolFileList(ISeriesSplfFilterString fsObj)
          Retrieve a list of SpoolFiles, returning information common to SpoolFiles of both database and device files.
 List getSpoolFileList(ISeriesSplfFilterString fsObj, IISeriesHostListSpoolFileFactory listSpoolFileFactory)
          Retrieve a list of SpoolFiles, returning objects created by a supplied object factory.
 List getSpoolFileList(ISeriesSplfFilterString fsObj, IISeriesHostListSpoolFileFactory listSpoolFileFactory, IISeriesHostListStatusCallback callback)
          Retrieve a list of SpoolFiles, informing the caller when processing starts for each part of a multi-generic list.
 List getSpoolFileListNameOnly(ISeriesSplfFilterString fsObj)
          Retrieve a list of SpoolFiles, returning only the name per SpoolFile.
protected  void populateObj()
          Build a return object with information for one SpoolFile object.
protected  void setFilterStringObj(ISeriesSplfFilterString fsObj)
          Set the filter string used for this list request.
protected  void setListSpoolFileFactory(IISeriesHostListSpoolFileFactory factory)
          Set list SpoolFile factory used to create new objects.
 void setListType(int listType)
          Set the list type.
 void setSystem(AS400 system)
          Set the AS/400 object used for this list processor.
 
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, setTracing, setUserSpaceLibrary, setUserSpaceName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesAPIProcessor
getWarnings
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values

LIST_NAMES

public static final int LIST_NAMES
Return list of names only.

See Also:
Constant Field Values

LIST_BASIC

public static final int LIST_BASIC
Return list with basic information per SpoolFile (IISeriesHostSpoolFileBasic)

See Also:
Constant Field Values
Constructor Detail

ISeriesListSpoolFiles

public ISeriesListSpoolFiles()
Constructor used when you do not have an AS400 object already. A new AS400 object will be created when getList is called, unless you subsequently call setSystem(AS400) first.


ISeriesListSpoolFiles

public ISeriesListSpoolFiles(AS400 system)
Constructor when there is an existing AS400 object.

Parameters:
AS400 - system to use for the connection.
Method Detail

getListNameOnly

public List getListNameOnly(ISeriesAbstractFilterString fsObj)
                     throws Exception
As per the IISeriesListProcessor interface requirements. Not typesafe. Retrieve a list of SpoolFiles, returning only the name per SpoolFile.

Same as getListNameOnly(ISeriesAbstractFilterString)

Specified by:
getListNameOnly in interface IISeriesListProcessor
Returns:
List of ISeriesHostSpoolFileNameOnly objects.
Throws:
Exception

getListBrief

public List getListBrief(ISeriesAbstractFilterString fsObj)
                  throws Exception
As per the IISeriesListProcessor interface requirements. Not typesafe. Retrieve a list of SpoolFiles, returning only minimal info per SpoolFile. For SpoolFiles, this request is the same as getList(ISeriesAbstractFilterString)!

Specified by:
getListBrief in interface IISeriesListProcessor
Throws:
Exception

getList

public List getList(ISeriesAbstractFilterString fsObj)
             throws Exception
As per the IISeriesListProcessor interface requirements. Not typesafe. Retrieve a list of SpoolFiles, returning information common to SpoolFiles of both database and device files.

Specified by:
getList in interface IISeriesListProcessor
Returns:
List of ISeriesHostSpoolFileBasic objects.
Throws:
Exception

getList

public List getList(ISeriesAbstractFilterString fsObj,
                    IISeriesHostListBaseFactory listSpoolFileFactory)
             throws Exception
Retrieve a list of SpoolFiles, returning objects created by a supplied object factory.

As per the IISeriesListProcessor interface requirements. Not typesafe.

Specified by:
getList in interface IISeriesListProcessor
Throws:
Exception
See Also:
getSpoolFileList(ISeriesSplfFilterString, IISeriesHostListSpoolFileFactory)

getList

public List getList(ISeriesAbstractFilterString fsObj,
                    IISeriesHostListBaseFactory listSpoolFileFactory,
                    IISeriesHostListStatusCallback callback)
             throws Exception
Retrieve a list of SpoolFiles, informing the caller when processing starts for each part of a multi-generic list.

As per the IISeriesListProcessor interface requirements. Not typesafe.

Specified by:
getList in interface IISeriesListProcessor
Throws:
Exception
See Also:
getSpoolFileList(ISeriesSplfFilterString, IISeriesHostListSpoolFileFactory, IISeriesHostListStatusCallback)

getSpoolFileListNameOnly

public List getSpoolFileListNameOnly(ISeriesSplfFilterString fsObj)
                              throws Exception
Retrieve a list of SpoolFiles, returning only the name per SpoolFile. A type-safe overload.

Returns:
List of ISeriesHostSpoolFileNameOnly objects.
Throws:
Exception

getSpoolFileList

public List getSpoolFileList(ISeriesSplfFilterString fsObj)
                      throws Exception
Retrieve a list of SpoolFiles, returning information common to SpoolFiles of both database and device files. A type-safe overload.

Returns:
List of ISeriesHostSpoolFileBasic objects.
Throws:
Exception

getSpoolFileList

public List getSpoolFileList(ISeriesSplfFilterString fsObj,
                             IISeriesHostListSpoolFileFactory listSpoolFileFactory)
                      throws Exception
Retrieve a list of SpoolFiles, returning objects created by a supplied object factory.

A type-safe overload.

This is the API callers use when they want to create each object in the returned list, perhaps optimized for their environment. If you are ok with the default returned objects, then just use one of the other getList variations. All others internally call this method with a default factory object.

Note this supports multi-generic lists, where the library and/or file are generic. In this case, the list of libraries will be retrieved first, then for each library the list of files. Finally, for every resulting file, the SpoolFile list as requested is retrieved. The entire list of all SpoolFiles is concatenated together and returned as a single list.

Parameters:
fsObj - ISeriesSpoolFileFilterString filter string object identify what list to get. To construct one of these, pass a string of the form library/file RCDNAME(SpoolFile) to its constructor. The SpoolFile name can simple, * or generic as in A*.
listSpoolFileFactory - An object implementing the IISeriesHostListSpoolFileFactory interface. This interface prescribes three methods, and the one called depends on the type of list requested:
  1. LIST_NAMES calls createNameOnlyObject.
  2. LIST_BASIC calls createSpoolFileObject.
  3. #LIST_DEVICE calls createDeviceSpoolFileObject.
Throws:
Exception

getListType

public int getListType()
Retrieve file override value.

Returns:
int

setListType

public void setListType(int listType)
Set the list type. Call before calling any flavor of getList(...). Default is basic.

Parameters:
listType - One of LIST_NAMES, LIST_BASIC, #LIST_DEVICE depending if you want:
  • only SpoolFile names returned.
  • SpoolFile information common to SpoolFiles of both database and device files
  • SpoolFile information specific to SpoolFiles of device files

  • getSpoolFileList

    public List getSpoolFileList(ISeriesSplfFilterString fsObj,
                                 IISeriesHostListSpoolFileFactory listSpoolFileFactory,
                                 IISeriesHostListStatusCallback callback)
                          throws Exception
    Retrieve a list of SpoolFiles, informing the caller when processing starts for each part of a multi-generic list.

    A type-safe overload.

    This is the same as the getList(ISeriesAbstractFilterString, IISeriesHostListBaseFactory, IISeriesHostListStatusCallback) method, but includes a callback object that is called when processing starts for each part of a multi-generic list request. A multi-generic SpoolFile list is a request where either the library or the file name are themselves generic, requiring multiple calls to the host SpoolFile list API.

    This version of getList is usually used by GUI code that wishes to update a status dialog.

    Throws:
    Exception

    getListHeader

    public ISeriesListSpoolFilesHeader getListHeader()
    This method returns the SpoolFile list header information. This is information pertaining to the file containing the SpoolFiles, and is the header part of the information returned by the system API QUSLSPL which is used to get the list. THIS METHOD CAN ONLY BE CALLED AFTER CALLING GETLIST. It returns the header information from the previous getList request.

    Returns:
    ISeriesListSpoolFilesHeader object

    getListFromAS400

    protected void getListFromAS400(String filterString)
                             throws Exception
    Call QUSLRCD on AS/400 to get the list. Updates theSpoolFileList global list

    Throws:
    Exception

    buildList

    protected void buildList(int nbrRows,
                             int listStartingPosition,
                             int sizePerRow)
                      throws Exception
    Build the list. Parse whole chunk of data by sizePerItem. For each parsed piece, call populateObj to create and populate a returned object, that is added to the list. Overridden from parent. Updates theSpoolFileList global list.

    Throws:
    Exception

    populateObj

    protected void populateObj()
    Build a return object with information for one SpoolFile object.

    Parameters:
    lib - obj to populate
    int - index into the String where item starts.
    param - int

    setListSpoolFileFactory

    protected void setListSpoolFileFactory(IISeriesHostListSpoolFileFactory factory)
    Set list SpoolFile factory used to create new objects. This is given to us by the caller, or else we use a default.


    getListSpoolFileFactory

    protected IISeriesHostListSpoolFileFactory getListSpoolFileFactory()
    Get object factory used to create new objects. This is given to us by the caller, or else we use a default.


    setFilterStringObj

    protected void setFilterStringObj(ISeriesSplfFilterString fsObj)
    Set the filter string used for this list request.


    getFilterStringObject

    protected ISeriesSplfFilterString getFilterStringObject()
    Return the filter string object used for this list request.


    getFilterString

    protected String getFilterString()
    Return the filter string used for this list request.


    setSystem

    public void setSystem(AS400 system)
    Description copied from class: ISeriesAbstractHostAPIProcessor
    Set the AS/400 object used for this list processor.

    Overrides:
    setSystem in class ISeriesAbstractHostAPIProcessor

    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.