Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.comm.interfaces
Class ISeriesHostFormatDefinition

java.lang.Object
  extended by com.ibm.etools.iseries.comm.interfaces.ISeriesHostFormatDefinition
All Implemented Interfaces:
IISeriesHostFormatDefinition
Direct Known Subclasses:
ISeriesHostDisplayFileRecord

public class ISeriesHostFormatDefinition
extends Object
implements IISeriesHostFormatDefinition

Class represents the information for an iSeries record file. This class is used with the ISeriesRetrieveDatabaseFileDescription.retrieveFormatDefinition


Field Summary
static String Copyright
           
 
Constructor Summary
ISeriesHostFormatDefinition()
           
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values
Constructor Detail

ISeriesHostFormatDefinition

public ISeriesHostFormatDefinition()
Method Detail

getName

public String getName()
Description copied from interface: IISeriesHostFormatDefinition
Get the name of the record format.

Specified by:
getName in interface IISeriesHostFormatDefinition
See Also:
IISeriesHostFormatDefinition.getName()

getLength

public int getLength()
Description copied from interface: IISeriesHostFormatDefinition
Get the record format length.

Specified by:
getLength in interface IISeriesHostFormatDefinition
See Also:
IISeriesHostFormatDefinition.getLength()

getCCSID

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

Specified by:
getCCSID in interface IISeriesHostFormatDefinition
See Also:
IISeriesHostFormatDefinition.getCCSID()

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
See Also:
IISeriesHostFormatDefinition.hasDBCSorGraphicData()

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.
See Also:
IISeriesHostFormatDefinition.getFields()

setName

public void setName(String name)
Description copied from interface: IISeriesHostFormatDefinition
Set the record format's name.

Specified by:
setName in interface IISeriesHostFormatDefinition
See Also:
IISeriesHostFormatDefinition.setName(String)

setLength

public void setLength(int length)
Description copied from interface: IISeriesHostFormatDefinition
Set the record format's length

Specified by:
setLength in interface IISeriesHostFormatDefinition
See Also:
IISeriesHostFormatDefinition.setLength(int)

setCCSID

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

Specified by:
setCCSID in interface IISeriesHostFormatDefinition
See Also:
IISeriesHostFormatDefinition.setCCSID(int)

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
See Also:
IISeriesHostFormatDefinition.setDBCSorGraphicData(boolean)

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.
See Also:
IISeriesHostFormatDefinition.setFields(List)

getDescription

public String getDescription()
Description copied from interface: IISeriesHostFormatDefinition
Get the description for the record format.

Specified by:
getDescription in interface IISeriesHostFormatDefinition
See Also:
IISeriesHostFormatDefinition.getDescription()

getID

public String getID()
Description copied from interface: IISeriesHostFormatDefinition
Get the level identifier for the record format.

Specified by:
getID in interface IISeriesHostFormatDefinition
See Also:
IISeriesHostFormatDefinition.getID()

setDescription

public void setDescription(String description)
Description copied from interface: IISeriesHostFormatDefinition
Set the record format's text description

Specified by:
setDescription in interface IISeriesHostFormatDefinition
See Also:
IISeriesHostFormatDefinition.setDescription(String)

setID

public void setID(String id)
Description copied from interface: IISeriesHostFormatDefinition
Set the record format's level identifier

Specified by:
setID in interface IISeriesHostFormatDefinition
See Also:
com.ibm.etools.iseries.comm.interfaces.IISeriesHostFormatDefinition#setLevelID(String)

getFile

public String getFile()
Description copied from interface: IISeriesHostFormatDefinition
Get the filename for the file

Specified by:
getFile in interface IISeriesHostFormatDefinition

setFile

public void setFile(String file)
Description copied from interface: IISeriesHostFormatDefinition
Get the filename for the file

Specified by:
setFile in interface IISeriesHostFormatDefinition

getLibrary

public String getLibrary()
Description copied from interface: IISeriesHostFormatDefinition
Get the library for the file

Specified by:
getLibrary in interface IISeriesHostFormatDefinition

setLibrary

public void setLibrary(String library)
Description copied from interface: IISeriesHostFormatDefinition
Get the library for the file

Specified by:
setLibrary in interface IISeriesHostFormatDefinition

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.