Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.comm
Class ISeriesRetrieveSaveFileDescription

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

public class ISeriesRetrieveSaveFileDescription
extends ISeriesAbstractHostAPIProcessor

A class to retrieve the save command and save library from a save file


Nested Class Summary
protected  class ISeriesRetrieveSaveFileDescription.API_Output
          A protected class to return the output from calling the AS400 API's.
 
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
ISeriesRetrieveSaveFileDescription()
           
 
Method Summary
 void main()
          Run the action
 String[] retrieveLibraryAndCommandUsed(String libraryName, String fileName)
          Retrieve the library name and command used to save the save 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

ISeriesRetrieveSaveFileDescription

public ISeriesRetrieveSaveFileDescription()
Method Detail

retrieveLibraryAndCommandUsed

public String[] retrieveLibraryAndCommandUsed(String libraryName,
                                              String fileName)
                                       throws Exception
Retrieve the library name and command used to save the save file

Parameters:
libraryName - library where the file is located, can be either a library name, *CURLIB or *LIBL
fileName - name of the file
Returns:
String[] - String array containing library and save command used
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

main

public void main()
Run the action


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.