Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.comm
Class ISeriesRetrieveDatabaseMemberDescription

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

public class ISeriesRetrieveDatabaseMemberDescription
extends ISeriesAbstractHostAPIProcessor

A class for retrieving the member definition template for an iSeries file. This class uses the QUSRMBRD OS/400 api to retrieve the information. It models after ISeriesRetrieveDatabaseFileDescription


Nested Class Summary
protected  class ISeriesRetrieveDatabaseMemberDescription.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
ISeriesRetrieveDatabaseMemberDescription()
          Constructor used when you do not have an AS400 object already.
ISeriesRetrieveDatabaseMemberDescription(AS400 system)
          Constructor for ISeriesRetrieveDatabaseMemberDescription.
 
Method Summary
 boolean isAllowOverrides()
          Returns the allowOverrides.
 ISeriesHostMemberDefinition retrieveMemberDefinition(String libraryName, String fileName, String memberName)
          Method retrieveMemberDefinition.
 void setAllowOverrides(boolean allowOverrides)
          Sets the allowOverrides.
 
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

ISeriesRetrieveDatabaseMemberDescription

public ISeriesRetrieveDatabaseMemberDescription()
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.


ISeriesRetrieveDatabaseMemberDescription

public ISeriesRetrieveDatabaseMemberDescription(AS400 system)
Constructor for ISeriesRetrieveDatabaseMemberDescription.

Method Detail

retrieveMemberDefinition

public ISeriesHostMemberDefinition retrieveMemberDefinition(String libraryName,
                                                            String fileName,
                                                            String memberName)
                                                     throws Exception
Method retrieveMemberDefinition. Retrieve the member definition for the member.

Parameters:
libraryName -
fileName -
memberName -
Returns:
ISeriesMemberDefinition
Throws:
Exception

isAllowOverrides

public boolean isAllowOverrides()
Returns the allowOverrides. The default is to allow overrides.

Returns:
boolean

setAllowOverrides

public void setAllowOverrides(boolean allowOverrides)
Sets the allowOverrides.

Parameters:
allowOverrides - The allowOverrides to set

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.