Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.services.qsys.objects
Class QSYSHostFile

java.lang.Object
  extended by com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectNameOnly
      extended by com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectBrief
          extended by com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectBasic
              extended by com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectExhaustive
                  extended by com.ibm.etools.iseries.services.qsys.objects.QSYSHostObject
                      extended by com.ibm.etools.iseries.services.qsys.objects.QSYSHostFile
All Implemented Interfaces:
IISeriesHostObjectBasic, IISeriesHostObjectBrief, IISeriesHostObjectExhaustive, IISeriesHostObjectNameOnly, IQSYSFile, IQSYSObject, IQSYSResource
Direct Known Subclasses:
QSYSHostDatabaseFile, QSYSHostDisplayFile, QSYSHostPrinterFile

public class QSYSHostFile
extends QSYSHostObject
implements IQSYSFile

Class representing an IBM i host file


Field Summary
static String copyright
           
 
Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectExhaustive
activeDate, allowChgByPgm, apar, auditingValue, auxPool, changedByPgm, compiler, compressionStatus, Copyright, daysUsed, domain, lastUsedDate, level, licPgm, overflowedASP, owner, primaryGroup, profile, ptf, resetDate, restoredDate, saveCmd, saveDate, saveDevice, saveFile, saveLabel, saveLib, saveSeqNbr, saveSize, saveVolumeId, srcDate, srcFile, srcLib, srcMbr, storage, systemCreated, systemLevel, usageInfoUpdated, userChanged, userDefinedAttribute
 
Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectBasic
changeDate, createDate, size
 
Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectBrief
file, subtype, type
 
Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectNameOnly
library, name
 
Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive
AUDITING_ALL, AUDITING_CHANGE, AUDITING_NONE, AUDITING_USRPRF, COMPRESSION_COMPRESSED, COMPRESSION_NOTCOMPRESSABLE, COMPRESSION_NOTCOMPRESSED, COMPRESSION_SAVEDFREED, COMPRESSION_TEMPORARILYCOMPRESSED, Copyright, DOMAIN_SYSTEM, DOMAIN_USER, STORAGE_FREE, STORAGE_KEEP
 
Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
STATUS_DAMAGED, STATUS_LOCKED, STATUS_NOTAUTHORIZED, STATUS_OK, STATUS_PARTIALLYDAMAGED, STATUS_STRING_DAMAGED, STATUS_STRING_LOCKED, STATUS_STRING_NOTAUTHORIZED, STATUS_STRING_PARTIALLYDAMAGED
 
Constructor Summary
QSYSHostFile()
           
 
Method Summary
 IQSYSFileRecordFormat getRecordFormat(String record, IProgressMonitor monitor)
          Get the specified record.
 IQSYSFileRecordFormat[] listRecordFormats(IProgressMonitor monitor)
          Return a list of all records for this file.
 
Methods inherited from class com.ibm.etools.iseries.services.qsys.objects.QSYSHostObject
clearCachedProperties, exists, getParent
 
Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectExhaustive
getAllowChangeByProgram, getAPAR, getAuxiliaryStoragePool, getChangedByProgram, getCompiler, getCompressionStatus, getCreatorUserProfile, getDaysUsedCount, getDomain, getLastUsedDate, getLicensedProgram, getObjectAuditingValue, getObjectLevel, getObjectOverflowedASP, getOwner, getPrimaryGroup, getPTF, getResetDate, getRestoredDate, getSaveActiveDate, getSaveCommand, getSavedDate, getSaveDevice, getSaveFileName, getSaveLabel, getSaveLibrary, getSaveSequenceNumber, getSaveSize, getSaveVolumeId, getSourceChangedDate, getSourceFile, getSourceLibrary, getSourceMember, getStorage, getSystemLevel, getSystemWhereCreated, getUsageInformationUpdated, getUserChanged, getUserDefinedAttribute, setAllowChangeByProgram, setAPAR, setAuxiliaryStoragePool, setChangedByProgram, setCompiler, setCompressionStatus, setCreatorUserProfile, setDaysUsedCount, setDomain, setLastUsedDate, setLicensedProgram, setObjectAuditingValue, setObjectLevel, setObjectOverflowedASP, setOwner, setPrimaryGroup, setPTF, setResetDate, setRestoredDate, setSaveActiveDate, setSaveCommand, setSavedDate, setSaveDevice, setSaveFileName, setSaveLabel, setSaveLibrary, setSaveSequenceNumber, setSaveSize, setSaveVolumeId, setSourceChangedDate, setSourceFile, setSourceLibrary, setSourceMember, setStorage, setSystemLevel, setSystemWhereCreated, setUsageInformationUpdated, setUserChanged, setUserDefinedAttribute, writeObjectInfo
 
Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectBasic
equals, getAbsoluteName, getDateCreated, getDateModified, getFullName, getSize, hashCode, setDateCreated, setDateModified, setSize
 
Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectBrief
getDescription, getFile, getInformationStatus, getSubType, getType, setDescription, setFile, setInformationStatus, setSubType, setType, toString
 
Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectNameOnly
getLibrary, getName, setLibrary, setName
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.etools.iseries.services.qsys.api.IQSYSObject
clearCachedProperties
 
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive
getAllowChangeByProgram, getAPAR, getAuxiliaryStoragePool, getChangedByProgram, getCompiler, getCompressionStatus, getCreatorUserProfile, getDaysUsedCount, getDomain, getLastUsedDate, getLicensedProgram, getObjectAuditingValue, getObjectLevel, getObjectOverflowedASP, getOwner, getPrimaryGroup, getPTF, getResetDate, getRestoredDate, getSaveActiveDate, getSaveCommand, getSavedDate, getSaveDevice, getSaveFileName, getSaveLabel, getSaveLibrary, getSaveSequenceNumber, getSaveSize, getSaveVolumeId, getSourceChangedDate, getSourceFile, getSourceLibrary, getSourceMember, getStorage, getSystemLevel, getSystemWhereCreated, getUsageInformationUpdated, getUserChanged, getUserDefinedAttribute, setAllowChangeByProgram, setAPAR, setAuxiliaryStoragePool, setChangedByProgram, setCompiler, setCompressionStatus, setCreatorUserProfile, setDaysUsedCount, setDomain, setLastUsedDate, setLicensedProgram, setObjectAuditingValue, setObjectLevel, setObjectOverflowedASP, setOwner, setPrimaryGroup, setPTF, setResetDate, setRestoredDate, setSaveActiveDate, setSaveCommand, setSavedDate, setSaveDevice, setSaveFileName, setSaveLabel, setSaveLibrary, setSaveSequenceNumber, setSaveSize, setSaveVolumeId, setSourceChangedDate, setSourceFile, setSourceLibrary, setSourceMember, setStorage, setSystemLevel, setSystemWhereCreated, setUsageInformationUpdated, setUserChanged, setUserDefinedAttribute
 
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic
getDateCreated, getDateModified, getSize, setDateCreated, setDateModified, setSize
 
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
getDescription, getFile, getInformationStatus, getSubType, getType, setDescription, setFile, setInformationStatus, setSubType, setType
 
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly
getLibrary, getName, setLibrary, setName, toString, writeObjectInfo
 
Methods inherited from interface com.ibm.etools.iseries.services.qsys.api.IQSYSResource
exists, getAbsoluteName, getDateCreated, getDateModified, getDescription, getFullName, getLibrary, getName, getParent, getSize, getSubType, getType, setDescription, setLibrary, setName, setSubType, setType
 

Field Detail

copyright

public static String copyright
Constructor Detail

QSYSHostFile

public QSYSHostFile()
Method Detail

getRecordFormat

public IQSYSFileRecordFormat getRecordFormat(String record,
                                             IProgressMonitor monitor)
                                      throws SystemMessageException,
                                             InterruptedException
Description copied from interface: IQSYSFile
Get the specified record.

Specified by:
getRecordFormat in interface IQSYSFile
Throws:
SystemMessageException
InterruptedException

listRecordFormats

public IQSYSFileRecordFormat[] listRecordFormats(IProgressMonitor monitor)
                                          throws SystemMessageException,
                                                 InterruptedException
Description copied from interface: IQSYSFile
Return a list of all records for this file.

Specified by:
listRecordFormats in interface IQSYSFile
Throws:
SystemMessageException
InterruptedException

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.