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

All Superinterfaces:

IISeriesHostObjectNameOnly, IISeriesHostRecordBasic, IISeriesHostRecordNameOnly

All Known Subinterfaces:

IQSYSDatabaseFileRecordFormat, IQSYSDeviceFileRecordFormat

All Known Implementing Classes:

QSYSHostDatabaseFileRecordFormat, QSYSHostFileRecordFormat, QSYSRemoteDatabaseFileRecordFormat, QSYSRemoteFileRecordFormat

public interface IQSYSFileRecordFormat
extends IISeriesHostRecordBasic

Interface representing an IBM i file record.

Field Summary

static String

copyright

Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordBasic

Copyright

Method Summary

String	getAbsoluteName() Get the absolute name for the record
IQSYSFileField	getField(String fieldName, IProgressMonitor monitor) Returns the specified field within the records format or null if the field does not exist
IQSYSFile	getParent() Return the parent of this object
void	setParent(IQSYSFile file) Return the parent of this object

Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordBasic

getDescription, getFieldCount, getID, getLength, setDescription, setFieldCount, setID, setLength

Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordNameOnly

getFile, getFileType, setFile, setFileType, toString, writeObjectInfo

Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly

getLibrary, getName, setLibrary, setName

Field Detail

copyright

static final String copyright

See Also:

Constant Field Values

Method Detail

getParent

IQSYSFile getParent()
                    throws SystemMessageException,
                           InterruptedException

Return the parent of this object

Throws:

SystemMessageException

InterruptedException

setParent

void setParent(IQSYSFile file)
               throws SystemMessageException,
                      InterruptedException

Return the parent of this object

Throws:

SystemMessageException

InterruptedException

getAbsoluteName

String getAbsoluteName()

Get the absolute name for the record

getField

IQSYSFileField getField(String fieldName,
                        IProgressMonitor monitor)
                        throws SystemMessageException,
                               InterruptedException

Returns the specified field within the records format or null if the field does not exist

Throws:

SystemMessageException

InterruptedException