com.ibm.etools.iseries.comm
Class ISeriesRetrieveDisplayFileDescription

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

All Implemented Interfaces:

IISeriesAPIProcessor

public class ISeriesRetrieveDisplayFileDescription
extends ISeriesAbstractHostAPIProcessor

This class wrappers the OS/400 Retrieve Display File Description (QDFRTVFD) system api which allows you to get specific information about the data description specifications (DDS) definition used to create a display file.

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

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

ISeriesRetrieveDisplayFileDescription(AS400 system)
Constructor for ISeriesRetrieveDisplayFileDescription.

Method Summary

IISeriesHostDisplayFileRecord[]

getDisplayFileRecords(String library, String displayFile) Retrieve the records for the display file.

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

ISeriesRetrieveDisplayFileDescription

public ISeriesRetrieveDisplayFileDescription()

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

ISeriesRetrieveDisplayFileDescription

public ISeriesRetrieveDisplayFileDescription(AS400 system)

Constructor for ISeriesRetrieveDisplayFileDescription.

Parameters:

system - The AS400 Toolbox object used to connect to the remote system.

Method Detail

getDisplayFileRecords

public IISeriesHostDisplayFileRecord[] getDisplayFileRecords(String library,
                                                             String displayFile)
                                                      throws ISeriesAPIErrorCodeException,
                                                             Exception

Retrieve the records for the display file.

Parameters:

library - library name for display file, this can be either a library name or *LIBL or *CURLIB

displayFile - display file name

Returns:

Array of IISeriesHostDisplayFileRecord instances, each representing a record in the display file.

Throws:

ISeriesAPIErrorCodeException - if there was an error while running the OS/400 system api

IBM - Toolbox for Java exceptions if there was a problem calling the OS/400 system api

Exception