Rational Developer for Power Systems Software
V7.6

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

All Superinterfaces:
IISeriesHostFileDefinition, IISeriesHostObjectBasic, IISeriesHostObjectBrief, IISeriesHostObjectExhaustive, IISeriesHostObjectNameOnly, IQSYSFile, IQSYSObject, IQSYSResource
All Known Subinterfaces:
IQSYSDataFile, IQSYSDDMFile, IQSYSLogicalFile, IQSYSPhysicalFile, IQSYSSourceFile
All Known Implementing Classes:
QSYSHostDatabaseFile, QSYSHostDataFile, QSYSHostDDMFile, QSYSHostLogicalFile, QSYSHostPhysicalFile, QSYSHostSourceFile, QSYSRemoteDatabaseFile, QSYSRemoteDataFile, QSYSRemoteDDMFile, QSYSRemoteLogicalFile, QSYSRemotePhysicalFile, QSYSRemoteSourceFile

public interface IQSYSDatabaseFile
extends IQSYSFile, IISeriesHostFileDefinition

Interface representing an IBM i database file. This is the parent to data, logical and source files.


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
 
Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostFileDefinition
ARRIVAL_SEQ, Copyright, ENCODED_VECTOR_SEQ, KEYED_FCFO_SEQ, KEYED_FIFO_SEQ, KEYED_LIFO_SEQ, KEYED_NO_ORDER_SEQ, KEYED_UNIQUE_SEQ
 
Method Summary
 IQSYSDatabaseFileRecordFormat getRecordFormat(IProgressMonitor monitor)
          Return the first record format in the physical file
 IQSYSDatabaseFileRecordFormat getRecordFormat(String record, IProgressMonitor monitor)
          Return the specified record format in the physical file
 void setBasedOnFiles(List<String> files)
          Set the based on files
 
Methods inherited from interface com.ibm.etools.iseries.services.qsys.api.IQSYSFile
listRecordFormats
 
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
 
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostFileDefinition
addBasedOnFile, getAccessPathType, getAlternateSequence, getBasedOnCount, getBasedOnFiles, getDynamicSelect, getIGCField, getIGCLiteral, getKeyedAccessPath, getLangId, getSelectOmitLF, isJoinLogicalFile, isSourceFile, setAccessPathType, setAlternateSequence, setBasedOnCount, setDynamicSelect, setIGCField, setIGCLiteral, setIsSourceFile, setJoinLogicalFile, setKeyedAccessPath, setLangId, setSelectOmitLF
 

Field Detail

copyright

static final String copyright
See Also:
Constant Field Values
Method Detail

getRecordFormat

IQSYSDatabaseFileRecordFormat getRecordFormat(IProgressMonitor monitor)
                                              throws SystemMessageException,
                                                     InterruptedException
Return the first record format in the physical file

Throws:
SystemMessageException
InterruptedException

getRecordFormat

IQSYSDatabaseFileRecordFormat getRecordFormat(String record,
                                              IProgressMonitor monitor)
                                              throws SystemMessageException,
                                                     InterruptedException
Return the specified record format in the physical file

Specified by:
getRecordFormat in interface IQSYSFile
Throws:
SystemMessageException
InterruptedException

setBasedOnFiles

void setBasedOnFiles(List<String> files)
Set the based on files


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.