Rational Developer for Power Systems Software
V7.6

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

java.lang.Object
  extended by com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectNameOnly
      extended by com.ibm.etools.iseries.comm.interfaces.ISeriesHostRecordNameOnly
          extended by com.ibm.etools.iseries.comm.interfaces.ISeriesHostRecordBasic
              extended by com.ibm.etools.iseries.services.qsys.objects.QSYSHostFileRecordFormat
                  extended by com.ibm.etools.iseries.services.qsys.objects.QSYSHostDatabaseFileRecordFormat
All Implemented Interfaces:
IISeriesHostFormatDefinition, IISeriesHostObjectNameOnly, IISeriesHostRecordBasic, IISeriesHostRecordNameOnly, IQSYSDatabaseFileRecordFormat, IQSYSFileRecordFormat
Direct Known Subclasses:
QSYSRemoteDatabaseFileRecordFormat

public class QSYSHostDatabaseFileRecordFormat
extends QSYSHostFileRecordFormat
implements IQSYSDatabaseFileRecordFormat

Class representing an IBM i database file record.


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
 
Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostFormatDefinition
Copyright
 
Constructor Summary
QSYSHostDatabaseFileRecordFormat()
           
 
Method Summary
 boolean equals(Object obj)
          Two QSYSHostDatabaseFileRecordFormat objects are equal if they have the same name, file, and library.
 int getCCSID()
          Get the CCSID for the record format.
 IQSYSDatabaseField getField(String fieldName, IProgressMonitor monitor)
          Returns the specified field within the records format or null if the field does not exist
 List getFields()
          Get the fields for this record format.
 boolean hasDBCSorGraphicData()
          Check if the record format has any DBCS or graphical data
 IQSYSDatabaseField[] listFields(IProgressMonitor monitor)
          Return a list of all fields in the record format.
 void setCCSID(int ccsid)
          Set the record format's CCSID
 void setDBCSorGraphicData(boolean dbcsGraphicData)
          Set whether or not the record format contains DBCS or graphic data.
 void setFields(List fields)
          Set the fields for this record format.
 
Methods inherited from class com.ibm.etools.iseries.services.qsys.objects.QSYSHostFileRecordFormat
getAbsoluteName, getParent, hashCode, setParent
 
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, getParent, setParent
 
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

QSYSHostDatabaseFileRecordFormat

public QSYSHostDatabaseFileRecordFormat()
Method Detail

equals

public boolean equals(Object obj)
Two QSYSHostDatabaseFileRecordFormat objects are equal if they have the same name, file, and library.

Overrides:
equals in class QSYSHostFileRecordFormat
See Also:
Object.equals(java.lang.Object)

getCCSID

public int getCCSID()
Description copied from interface: IISeriesHostFormatDefinition
Get the CCSID for the record format.

Specified by:
getCCSID in interface IISeriesHostFormatDefinition

hasDBCSorGraphicData

public boolean hasDBCSorGraphicData()
Description copied from interface: IISeriesHostFormatDefinition
Check if the record format has any DBCS or graphical data

Specified by:
hasDBCSorGraphicData in interface IISeriesHostFormatDefinition

getFields

public List getFields()
Description copied from interface: IISeriesHostFormatDefinition
Get the fields for this record format.

Specified by:
getFields in interface IISeriesHostFormatDefinition
Returns:
Collection of fields, each an instance of IISeriesHostDatabaseField.

setCCSID

public void setCCSID(int ccsid)
Description copied from interface: IISeriesHostFormatDefinition
Set the record format's CCSID

Specified by:
setCCSID in interface IISeriesHostFormatDefinition

setDBCSorGraphicData

public void setDBCSorGraphicData(boolean dbcsGraphicData)
Description copied from interface: IISeriesHostFormatDefinition
Set whether or not the record format contains DBCS or graphic data.

Specified by:
setDBCSorGraphicData in interface IISeriesHostFormatDefinition

setFields

public void setFields(List fields)
Description copied from interface: IISeriesHostFormatDefinition
Set the fields for this record format.

Specified by:
setFields in interface IISeriesHostFormatDefinition
Parameters:
fields - A collection containing instances of IISeriesHostDatabaseField.

getField

public IQSYSDatabaseField 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 IQSYSDatabaseFileRecordFormat
Specified by:
getField in interface IQSYSFileRecordFormat
Overrides:
getField in class QSYSHostFileRecordFormat
Throws:
SystemMessageException
InterruptedException

listFields

public IQSYSDatabaseField[] listFields(IProgressMonitor monitor)
                                throws SystemMessageException,
                                       InterruptedException
Description copied from interface: IQSYSDatabaseFileRecordFormat
Return a list of all fields in the record format.

Specified by:
listFields in interface IQSYSDatabaseFileRecordFormat
Throws:
SystemMessageException
InterruptedException

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.