Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.comm
Class ISeriesListFieldsHeader

java.lang.Object
  extended by com.ibm.etools.iseries.comm.ISeriesListFieldsHeader

public class ISeriesListFieldsHeader
extends Object

This class encapuslates the field list header information available after a call to ISeriesListFields. This is information pertaining to the file which contained the fields retrieved.


Field Summary
static String Copyright
           
 
Constructor Summary
protected ISeriesListFieldsHeader(AS400 system, byte[] data400, int headerOffset, int hostCCSID)
          The constructor is not public.
 
Method Summary
 String getFileLibrary()
          Return name of library containing file used to get the list.
 String getFileName()
          Return name of file used to get the list.
 String getFileType()
          Return type of file used to get the list.
 boolean getHasDateAndTimeFields()
          Return true if record format used to get the list contains date and time fields.
 boolean getHasGraphicFields()
          Return true if record format used to get the list contains graphic fields.
 boolean getHasNullCapableFields()
          Return true if record format used to get the list contains null capable fields.
 boolean getHasVariableLengthFields()
          Return true if record format used to get the list contains variable length fields.
 String getRecordDescription()
          Return description of record format used to get the list.
 int getRecordDescriptionCCSID()
          Return host CCSID of description of record format used to get the list.
 String getRecordFormatID()
          Return ID of record format used to get the list.
 String getRecordFormatName()
          Return record format name used to get the list.
 int getRecordLength()
          Return length of record format used to get the list.
 void writeHeaderInfo(PrintWriter logFileStream)
          Write out to file stream information in this header.
 
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

ISeriesListFieldsHeader

protected ISeriesListFieldsHeader(AS400 system,
                                  byte[] data400,
                                  int headerOffset,
                                  int hostCCSID)
The constructor is not public. Only ISeriesListFields can create objects of this class.

Method Detail

getFileName

public String getFileName()
Return name of file used to get the list.


getFileLibrary

public String getFileLibrary()
Return name of library containing file used to get the list.


getFileType

public String getFileType()
Return type of file used to get the list.


getRecordFormatName

public String getRecordFormatName()
Return record format name used to get the list.


getRecordFormatID

public String getRecordFormatID()
Return ID of record format used to get the list.


getRecordLength

public int getRecordLength()
Return length of record format used to get the list.


getRecordDescription

public String getRecordDescription()
Return description of record format used to get the list.


getRecordDescriptionCCSID

public int getRecordDescriptionCCSID()
Return host CCSID of description of record format used to get the list.


getHasVariableLengthFields

public boolean getHasVariableLengthFields()
Return true if record format used to get the list contains variable length fields.


getHasGraphicFields

public boolean getHasGraphicFields()
Return true if record format used to get the list contains graphic fields.


getHasDateAndTimeFields

public boolean getHasDateAndTimeFields()
Return true if record format used to get the list contains date and time fields.


getHasNullCapableFields

public boolean getHasNullCapableFields()
Return true if record format used to get the list contains null capable fields.


writeHeaderInfo

public void writeHeaderInfo(PrintWriter logFileStream)
Write out to file stream information in this header. To write to System.out pass new PrintWriter(System.out)


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.