com.ibm.etools.iseries.services.qsys.api
Interface IQSYSFile

All Superinterfaces:

IISeriesHostObjectBasic, IISeriesHostObjectBrief, IISeriesHostObjectExhaustive, IISeriesHostObjectNameOnly, IQSYSObject, IQSYSResource

All Known Subinterfaces:

IQSYSDatabaseFile, IQSYSDataFile, IQSYSDDMFile, IQSYSDisplayFile, IQSYSLogicalFile, IQSYSPhysicalFile, IQSYSPrinterFile, IQSYSSourceFile

All Known Implementing Classes:

QSYSHostDatabaseFile, QSYSHostDataFile, QSYSHostDDMFile, QSYSHostDisplayFile, QSYSHostFile, QSYSHostLogicalFile, QSYSHostPhysicalFile, QSYSHostPrinterFile, QSYSHostSourceFile, QSYSRemoteDatabaseFile, QSYSRemoteDataFile, QSYSRemoteDDMFile, QSYSRemoteDisplayFile, QSYSRemoteFile, QSYSRemoteLogicalFile, QSYSRemotePhysicalFile, QSYSRemotePrinterFile, QSYSRemoteSourceFile

public interface IQSYSFile
extends IQSYSObject

Interface representing an IBM i native file object.

Field Summary

static String

copyright

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

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

static final String copyright

See Also:

Constant Field Values

Method Detail

listRecordFormats

IQSYSFileRecordFormat[] listRecordFormats(IProgressMonitor monitor)
                                          throws SystemMessageException,
                                                 InterruptedException

Return a list of all records for this file.

Throws:

SystemMessageException

InterruptedException

getRecordFormat

IQSYSFileRecordFormat getRecordFormat(String record,
                                      IProgressMonitor monitor)
                                      throws SystemMessageException,
                                             InterruptedException

Get the specified record.

Throws:

SystemMessageException

InterruptedException