Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.comm.interfaces
Interface IISeriesHostFormatDefinition

All Known Subinterfaces:
IISeriesHostDisplayFileRecord, IQSYSDatabaseFileRecordFormat
All Known Implementing Classes:
ISeriesHostDisplayFileRecord, ISeriesHostFormatDefinition, QSYSHostDatabaseFileRecordFormat, QSYSRemoteDatabaseFileRecordFormat

public interface IISeriesHostFormatDefinition

Interface representing a record format definition for an iSeries Database file. The represents the format FILD0200 for the QDBRTVFD api.

See Also:
ISeriesRetrieveDatabaseFileDescription

Field Summary
static String Copyright
           
 
Method Summary
 int getCCSID()
          Get the CCSID for the record format.
 String getDescription()
          Get the description for the record format.
 List getFields()
          Get the fields for this record format.
 String getFile()
          Get the filename for the file
 String getID()
          Get the level identifier for the record format.
 int getLength()
          Get the record format length.
 String getLibrary()
          Get the library for the file
 String getName()
          Get the name of the record format.
 boolean hasDBCSorGraphicData()
          Check if the record format has any DBCS or graphical data
 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 setDescription(String description)
          Set the record format's text description
 void setFields(List fields)
          Set the fields for this record format.
 void setFile(String file)
          Get the filename for the file
 void setID(String id)
          Set the record format's level identifier
 void setLength(int length)
          Set the record format's length
 void setLibrary(String library)
          Get the library for the file
 void setName(String name)
          Set the record format's name.
 

Field Detail

Copyright

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

getLibrary

String getLibrary()
Get the library for the file


getFile

String getFile()
Get the filename for the file


getName

String getName()
Get the name of the record format.


getLength

int getLength()
Get the record format length.


getCCSID

int getCCSID()
Get the CCSID for the record format.


getID

String getID()
Get the level identifier for the record format.


getDescription

String getDescription()
Get the description for the record format.


hasDBCSorGraphicData

boolean hasDBCSorGraphicData()
Check if the record format has any DBCS or graphical data


getFields

List getFields()
Get the fields for this record format.

Returns:
Collection of fields, each an instance of IISeriesHostDatabaseField.

setName

void setName(String name)
Set the record format's name.


setLength

void setLength(int length)
Set the record format's length


setCCSID

void setCCSID(int ccsid)
Set the record format's CCSID


setID

void setID(String id)
Set the record format's level identifier


setDescription

void setDescription(String description)
Set the record format's text description


setDBCSorGraphicData

void setDBCSorGraphicData(boolean dbcsGraphicData)
Set whether or not the record format contains DBCS or graphic data.


setFields

void setFields(List fields)
Set the fields for this record format.

Parameters:
fields - A collection containing instances of IISeriesHostDatabaseField.

setLibrary

void setLibrary(String library)
Get the library for the file


setFile

void setFile(String file)
Get the filename for the file


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.