com.ibm.etools.iseries.comm
Class ISeriesListMembersHeader

java.lang.Object
  com.ibm.etools.iseries.comm.ISeriesListMembersHeader

public class ISeriesListMembersHeader
extends Object

This class encapuslates the member list header information available after a call to ISeriesListMembers. This is information pertaining to the file which contained the members retrieved.

Field Summary

static String

Copyright

Constructor Summary

protected

ISeriesListMembersHeader(AS400 system, byte[] data400, int headerOffset, int hostCCSID) The constructor is not public.

Method Summary

String	getFileAttribute() Return attribute of file used to get list.
String	getFileDescription() Return description of file used to get list.
int	getFileDescriptionCCSID() Return host CCSID of description of file used to get list.
String	getFileLibrary() Return name of library containing file used to get list.
String	getFileName() Return name of file used to get list.
String	getFilePDMAttribute() Return attribute of file used to get list, suffixed with -SRC or -DTA as in PDM.
int	getNbrMembers() Return number of members in file used to get list.
boolean	isSourceFile() Return true if file used to get list is a source file versus a data file.
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

ISeriesListMembersHeader

protected ISeriesListMembersHeader(AS400 system,
                                   byte[] data400,
                                   int headerOffset,
                                   int hostCCSID)

The constructor is not public. Only ISeriesListMembers can create objects of this class.

Method Detail

getNbrMembers

public int getNbrMembers()

Return number of members in file used to get list.

getFileName

public String getFileName()

Return name of file used to get list.

getFileLibrary

public String getFileLibrary()

Return name of library containing file used to get list.

getFileAttribute

public String getFileAttribute()

Return attribute of file used to get list. For physical files this is just PF, not PF-SRC or PF-DTA. Other values are LF and DDMF.

See Also:

getFilePDMAttribute()

getFilePDMAttribute

public String getFilePDMAttribute()

Return attribute of file used to get list, suffixed with -SRC or -DTA as in PDM.

See Also:

getFileAttribute()

getFileDescription

public String getFileDescription()

Return description of file used to get list.

isSourceFile

public boolean isSourceFile()

Return true if file used to get list is a source file versus a data file.

getFileDescriptionCCSID

public int getFileDescriptionCCSID()

Return host CCSID of description of file used to get 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)