Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.comm
Class ISeriesListDatabaseFields

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

Deprecated. Use ISeriesRetrieveDatabaseFileDescription.retrieveFieldList() instead

public class ISeriesListDatabaseFields
extends ISeriesAbstractHostAPIProcessor

A class for listing fields in a *FILE PF-DTA object on an ISeries. This is done by invoking the QVDEFILE program on the iSeries which in turn uses the QDBRTVFD OS/400 api.

The output of the list request getFieldList(String, String, String) is a List of objects that implement the com.ibm.etools.iseries.comm.interfaces.IISeriesHostDatabaseField.

For some callers, it is important for performance to get a list of their own objects, versus a list of objects of a hard-coded class that just needs to be subsequently traversed and the data copied. To enable this, use the method getFieldList(String, String, String, String, IISeriesHostListDatabaseFieldFactory). This requires an object implementing IISeriesHostListDatabaseFieldFactory which is used to create each object returned in the list. This factory must return objects that implement IISeriesHostDatabaseField


Nested Class Summary
 
Nested classes/interfaces inherited from class com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor
ISeriesAbstractHostAPIProcessor.HostAPIErrorCodeStructure
 
Field Summary
static String Copyright
          Deprecated.  
 
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
ISeriesListDatabaseFields()
          Deprecated. Constructor to use when you do not already have an AS400 object.
ISeriesListDatabaseFields(AS400 system)
          Deprecated. Constructor when there is an existing AS400 object.
 
Method Summary
 void clear()
          Deprecated. Clear the last query results.
 List getFieldList(ISeriesFieldFilterString fs)
          Deprecated. Retrieve a list of fields, returning objects created by a supplied object factory.
 List getFieldList(String library, String file, String record)
          Deprecated. Retrieve a list of fields, returning objects created by a supplied object factory.
 List getFieldList(String library, String file, String record, String field)
          Deprecated. Retrieve a list of fields, returning objects created by a supplied object factory.
 List getFieldList(String library, String file, String record, String field, IISeriesHostListDatabaseFieldFactory factory)
          Deprecated. Retrieve a list of fields, returning objects created by a supplied object factory.
 boolean getFileOverride()
          Deprecated. Query whether this list processor honors file override information
protected static String lookupKeyword(byte id)
          Deprecated.  
 void setFileOverride(boolean override)
          Deprecated. Specify whether file overrides are honored or not during list processing.
 
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
Deprecated. 
See Also:
Constant Field Values
Constructor Detail

ISeriesListDatabaseFields

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


ISeriesListDatabaseFields

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

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

lookupKeyword

protected static String lookupKeyword(byte id)
Deprecated. 

getFieldList

public List getFieldList(String library,
                         String file,
                         String record)
                  throws Exception
Deprecated. 
Retrieve a list of fields, returning objects created by a supplied object factory. This is the API callers use when they want to create each object in the returned list, perhaps optimized for their environment. This method uses the default factory for creating instances of IISeriesHostDatabaseField.

Note this API does not yet support multi-generic lists. Explicit names must be provided for the library, file and record parameters.

Parameters:
library - The library where the database file is located.
file - The file for which to retrieve field information.
record - The record for which to retrieve field information.
Returns:
A list of IISeriesHostDatabaseField instances, each representing a single field.
Throws:
Exception
See Also:
IISeriesHostDatabaseField

getFieldList

public List getFieldList(String library,
                         String file,
                         String record,
                         String field)
                  throws Exception
Deprecated. 
Retrieve a list of fields, returning objects created by a supplied object factory. This is the API callers use when they want to create each object in the returned list, perhaps optimized for their environment. This method uses the default factory for creating instances of IISeriesHostDatabaseField.

Note this API does not yet support multi-generic lists. Explicit names must be provided for the library, file and record parameters.

Parameters:
library - The library where the database file is located.
file - The file for which to retrieve field information.
record - The record for which to retrieve field information.
field - Name of the field to retrieve information for.
Returns:
A list of IISeriesHostDatabaseField instances, each representing a single field.
Throws:
Exception
See Also:
IISeriesHostDatabaseField

getFieldList

public List getFieldList(ISeriesFieldFilterString fs)
                  throws Exception
Deprecated. 
Retrieve a list of fields, returning objects created by a supplied object factory. This is the API callers use when they want to create each object in the returned list, perhaps optimized for their environment. This method uses the default factory for creating instances of IISeriesHostDatabaseField.

Note this API does not yet support multi-generic lists. Explicit names must be provided for the library, file and record parameters.

Parameters:
fs - Field filter string which contains the field filtering criteria.
Returns:
A list of IISeriesHostDatabaseField instances, each representing a single field.
Throws:
Exception
See Also:
IISeriesHostDatabaseField

getFieldList

public List getFieldList(String library,
                         String file,
                         String record,
                         String field,
                         IISeriesHostListDatabaseFieldFactory factory)
                  throws Exception
Deprecated. 
Retrieve a list of fields, returning objects created by a supplied object factory. 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 getFieldList method. All others internally call this method with a default factory object.

Note this API does not yet support multi-generic lists. Explicit names must be provided for the library, file and record parameters.

Parameters:
library - The library where the database file is located.
file - The file for which to retrieve field information.
record - The record for which to retrieve field information.
factory - An object implementing the IISeriesHostListDatabaseFieldFactory interface. This interface prescribes one method for creating instances of IISeriesHostDatabaseField
Returns:
A list of IISeriesHostDatabaseField instances, each representing a single field.
Throws:
Exception
See Also:
IISeriesHostDatabaseField

setFileOverride

public void setFileOverride(boolean override)
Deprecated. 
Specify whether file overrides are honored or not during list processing.

Parameters:
override - A value of true will honor file overrides, a value of false will not honor file overrides.

getFileOverride

public boolean getFileOverride()
Deprecated. 
Query whether this list processor honors file override information


clear

public void clear()
Deprecated. 
Clear the last query results. The result of the last query is stored for each instance of ISeriesListDdatabaseFields for performance. Call this method to force a new query everytime.


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.