com.ibm.etools.iseries.comm
Class ISeriesRetrieveFileOverrideInformation

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

All Implemented Interfaces:

IISeriesAPIProcessor

public class ISeriesRetrieveFileOverrideInformation
extends ISeriesAbstractHostAPIProcessor

Wrapper class for the OS/400 system api QDMRTVFO (Retrieve File Override Information). Returns the name of a file, library, member and override type that results from processing the TOFILE or MBR overrides for the user specified file name.

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, Copyright, 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

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

ISeriesRetrieveFileOverrideInformation(AS400 system)
Constructor for ISeriesRetrieveFileOverrideInfo.

Method Summary

ISeriesFileOverrideInformation	retrieveFileOverride(String filename) Retrieve file override information for the specified OS/400 filename.
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

Field Detail

copyright

public static final String copyright

See Also:

Constant Field Values

Constructor Detail

ISeriesRetrieveFileOverrideInformation

public ISeriesRetrieveFileOverrideInformation()

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

ISeriesRetrieveFileOverrideInformation

public ISeriesRetrieveFileOverrideInformation(AS400 system)

Constructor for ISeriesRetrieveFileOverrideInfo.

Parameters:

system - AS400 Toolbox object to use when connecting to the remote system.

Method Detail

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

See Also:

ISeriesAbstractHostAPIProcessor.setSystem(AS400)

retrieveFileOverride

public ISeriesFileOverrideInformation retrieveFileOverride(String filename)
                                                    throws Exception

Retrieve file override information for the specified OS/400 filename.

Parameters:

filename - Name of the file which the override information is to be retrieved for.

Returns:

ISeriesFileOverrideInformation Override information for the specified file, or null if there is no override for this file.

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