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

java.lang.Object
  com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectNameOnly
      com.ibm.etools.iseries.comm.interfaces.ISeriesHostRecordNameOnly
          com.ibm.etools.iseries.comm.interfaces.ISeriesHostRecordBasic
              com.ibm.etools.iseries.services.qsys.objects.QSYSHostFileRecordFormat

All Implemented Interfaces:

IISeriesHostObjectNameOnly, IISeriesHostRecordBasic, IISeriesHostRecordNameOnly, IQSYSFileRecordFormat

Direct Known Subclasses:

QSYSHostDatabaseFileRecordFormat, QSYSRemoteFileRecordFormat

public class QSYSHostFileRecordFormat
extends ISeriesHostRecordBasic
implements IQSYSFileRecordFormat

Class representing an IBM i file record format.

Field Summary

static String

copyright

Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostRecordBasic

Copyright, id, len, nbrFlds, text

Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostRecordNameOnly

file, fileType

Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectNameOnly

library, name

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

Copyright

Constructor Summary

QSYSHostFileRecordFormat()

Method Summary

boolean	equals(Object obj) Two QSYSHostFileRecordFormat objects are equal if they have the same name, file, and library.
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
int	hashCode()
void	setParent(IQSYSFile file) Return the parent of this object

Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostRecordBasic

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

Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostRecordNameOnly

getFile, getFileType, setFile, setFileType, 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.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

public static String copyright

Constructor Detail

QSYSHostFileRecordFormat

public QSYSHostFileRecordFormat()

Method Detail

equals

public boolean equals(Object obj)

Two QSYSHostFileRecordFormat objects are equal if they have the same name, file, and library.

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getParent

public IQSYSFile getParent()
                    throws SystemMessageException,
                           InterruptedException

Description copied from interface: IQSYSFileRecordFormat

Return the parent of this object

Specified by:

getParent in interface IQSYSFileRecordFormat

Throws:

SystemMessageException

InterruptedException

setParent

public void setParent(IQSYSFile file)
               throws SystemMessageException,
                      InterruptedException

Description copied from interface: IQSYSFileRecordFormat

Return the parent of this object

Specified by:

setParent in interface IQSYSFileRecordFormat

Throws:

SystemMessageException

InterruptedException

getAbsoluteName

public String getAbsoluteName()

Description copied from interface: IQSYSFileRecordFormat

Get the absolute name for the record

Specified by:

getAbsoluteName in interface IQSYSFileRecordFormat

getField

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

Description copied from interface: IQSYSFileRecordFormat

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

Specified by:

getField in interface IQSYSFileRecordFormat

Throws:

SystemMessageException

InterruptedException