Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.comm
Class ISeriesListRecordsHeader

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

public class ISeriesListRecordsHeader
extends Object

This class encapuslates the record list header information available after a call to ISeriesListRecords. This is information pertaining to the file which contained the records retrieved.


Field Summary
static String Copyright
           
 
Constructor Summary
protected ISeriesListRecordsHeader(AS400 system, byte[] data400, int headerOffset, int hostCCSID)
          The constructor is not public.
 
Method Summary
 Date getFileCreationDate()
          Return creation date of file used to get the list.
 String getFileDescription()
          Return description of file used to get the list.
 int getFileDescriptionCCSID()
          Return host CCSID of description of file used to get the list.
 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.
 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

ISeriesListRecordsHeader

protected ISeriesListRecordsHeader(AS400 system,
                                   byte[] data400,
                                   int headerOffset,
                                   int hostCCSID)
The constructor is not public. Only ISeriesListRecords 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.


getFileDescription

public String getFileDescription()
Return description of file used to get the list.


getFileDescriptionCCSID

public int getFileDescriptionCCSID()
Return host CCSID of description of file used to get the list.


getFileCreationDate

public Date getFileCreationDate()
Return creation date of file used to get the list.


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.