com.ibm.etools.iseries.subsystems.qsys.objects
Class QSYSRemoteDatabaseFileRecordFormat

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
                  com.ibm.etools.iseries.services.qsys.objects.QSYSHostDatabaseFileRecordFormat
                      com.ibm.etools.iseries.subsystems.qsys.objects.QSYSRemoteDatabaseFileRecordFormat

All Implemented Interfaces:

IISeriesHostFormatDefinition, IISeriesHostObjectNameOnly, IISeriesHostRecordBasic, IISeriesHostRecordNameOnly, IQSYSDatabaseFileRecordFormat, IQSYSFileRecordFormat, IRemoteObjectContextProvider

public class QSYSRemoteDatabaseFileRecordFormat
extends QSYSHostDatabaseFileRecordFormat
implements IRemoteObjectContextProvider

Class representing an IBM i native (QSYS) database file record. This class is used by (and is knowledgeable of) RSE connections and subsystems. This class should not be directly referenced. All access should be done using the corresponding IQSYSDatabaseFileRecordFormat and IRemoteObjectContextProvider interfaces.

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

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

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

Copyright

Constructor Summary

QSYSRemoteDatabaseFileRecordFormat()

Method Summary

Object	getAdapter(Class adapter)
IQSYSDatabaseField	getField(String fieldName, IProgressMonitor monitor) Returns the specified field within the records format or null if the field does not exist
List	getFields() This method should be avoided.
IQSYSFile	getParent() Return the parent of this object
IRemoteObjectContext	getRemoteObjectContext() Get the remote context.
IQSYSDatabaseField[]	listFields(IProgressMonitor monitor) Return a list of all fields in the record format.
void	setParent(IQSYSFile file) Return the parent of this object
void	setRemoteObjectContext(IRemoteObjectContext context) Set the context for the remote object

Methods inherited from class com.ibm.etools.iseries.services.qsys.objects.QSYSHostDatabaseFileRecordFormat

equals, getCCSID, hasDBCSorGraphicData, setCCSID, setDBCSorGraphicData, setFields

Methods inherited from class com.ibm.etools.iseries.services.qsys.objects.QSYSHostFileRecordFormat

getAbsoluteName, hashCode

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.services.qsys.api.IQSYSFileRecordFormat

getAbsoluteName

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

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

getDescription, getFile, getID, getLength, getLibrary, getName, setDescription, setFile, setID, setLength, setLibrary, setName

Field Detail

copyright

public static String copyright

Constructor Detail

QSYSRemoteDatabaseFileRecordFormat

public QSYSRemoteDatabaseFileRecordFormat()

Method Detail

getAdapter

public Object getAdapter(Class adapter)

getRemoteObjectContext

public IRemoteObjectContext getRemoteObjectContext()

Description copied from interface: IRemoteObjectContextProvider

Get the remote context.

Specified by:

getRemoteObjectContext in interface IRemoteObjectContextProvider

setRemoteObjectContext

public void setRemoteObjectContext(IRemoteObjectContext context)

Set the context for the remote object

Specified by:

setRemoteObjectContext in interface IRemoteObjectContextProvider

getParent

public IQSYSFile getParent()
                    throws SystemMessageException,
                           InterruptedException

Description copied from interface: IQSYSFileRecordFormat

Return the parent of this object

Specified by:

getParent in interface IQSYSFileRecordFormat

Overrides:

getParent in class QSYSHostFileRecordFormat

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

Overrides:

setParent in class QSYSHostFileRecordFormat

Throws:

SystemMessageException

InterruptedException

getFields

public List getFields()

This method should be avoided. Use the type save listFields or getField method instead. (non-Javadoc)

Specified by:

getFields in interface IISeriesHostFormatDefinition

Overrides:

getFields in class QSYSHostDatabaseFileRecordFormat

Returns:

Collection of fields, each an instance of IISeriesHostDatabaseField.

See Also:

QSYSHostDatabaseFileRecordFormat.getFields()

listFields

public IQSYSDatabaseField[] listFields(IProgressMonitor monitor)
                                throws SystemMessageException,
                                       InterruptedException

Return a list of all fields in the record format.

Specified by:

listFields in interface IQSYSDatabaseFileRecordFormat

Overrides:

listFields in class QSYSHostDatabaseFileRecordFormat

Throws:

SystemMessageException

InterruptedException

getField

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

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

Specified by:

getField in interface IQSYSDatabaseFileRecordFormat

Specified by:

getField in interface IQSYSFileRecordFormat

Overrides:

getField in class QSYSHostDatabaseFileRecordFormat

Throws:

SystemMessageException

InterruptedException