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

java.lang.Object
  com.ibm.etools.iseries.comm.interfaces.ISeriesHostListObjectBasicFactory

All Implemented Interfaces:

IISeriesHostListBaseFactory, IISeriesHostListObjectFactory, IISeriesHostObjectFactory

public class ISeriesHostListObjectBasicFactory
extends Object
implements IISeriesHostListObjectFactory

This class is simply a factory for creating new instances of the ISeriesHostObjectBasic class for the ISeriesListObjects API.

Should somebody wish to use their own object instead they would:

create their own class that implements IISeriesHostObjectBasic

create their own factory class like this that implements IISeriesHostListObjectFactory with the methods prescribed by it.

when using comm layer code like ISeriesListObjects , you pass in your factory instance which is what is used to create the returned object.

See Also:

IISeriesHostListObjectFactory, IISeriesHostObjectBasic, ISeriesHostObjectBasic

Field Summary

static String	Copyright
protected boolean	wantSize

Constructor Summary

ISeriesHostListObjectBasicFactory()

Method Summary

IISeriesHostMemberNameOnly	createDataMember() Return an instance of a class that represents a data member.
IISeriesHostObjectNameOnly	createIFSFolderObject() Factory method called when the IFS list processor has determined the object being processed is a folder versus a file.
IISeriesHostObjectNameOnly	createLibraryObject() Factory method called when the list processor has determined the object being processed is a library object.
IISeriesHostObjectNameOnly	createObject(String type, String attribute) Factory method called when the list processor has determined the object being processed is not a library object or database file object.
IISeriesHostMemberNameOnly	createSourceMember() Return an instance of a class that represents a source member.
void	setWantToIncludeSize(boolean wantSize) Make it easy for users of this factory to state they don't want the size.
boolean	wantToIncludeSize() Tell the object list processor if the size is wanted.

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

wantSize

protected boolean wantSize

Constructor Detail

ISeriesHostListObjectBasicFactory

public ISeriesHostListObjectBasicFactory()

Method Detail

wantToIncludeSize

public boolean wantToIncludeSize()

Tell the object list processor if the size is wanted. The size per object is: - not available for *LIBL library list, member list and IFS list requests. - available but expensize for object lists. This boolean value only applies to OBJECT list requests for BASIC information. The default for this is true.

Specified by:

wantToIncludeSize in interface IISeriesHostListObjectFactory

setWantToIncludeSize

public void setWantToIncludeSize(boolean wantSize)

Make it easy for users of this factory to state they don't want the size. This boolean value only applies to OBJECT list requests for BASIC information.

createLibraryObject

public IISeriesHostObjectNameOnly createLibraryObject()

Factory method called when the list processor has determined the object being processed is a library object.

Specified by:

createLibraryObject in interface IISeriesHostListObjectFactory

createObject

public IISeriesHostObjectNameOnly createObject(String type,
                                               String attribute)

Factory method called when the list processor has determined the object being processed is not a library object or database file object.

Specified by:

createObject in interface IISeriesHostObjectFactory

Parameters:

type - The type of object requested.

attribute - The attribute of the object requested. The attribute may be null.

createIFSFolderObject

public IISeriesHostObjectNameOnly createIFSFolderObject()

Factory method called when the IFS list processor has determined the object being processed is a folder versus a file. Only used by the ISeriesListIFS api.

Specified by:

createIFSFolderObject in interface IISeriesHostListObjectFactory

createSourceMember

public IISeriesHostMemberNameOnly createSourceMember()

Description copied from interface: IISeriesHostListObjectFactory

Return an instance of a class that represents a source member.

Specified by:

createSourceMember in interface IISeriesHostListObjectFactory

createDataMember

public IISeriesHostMemberNameOnly createDataMember()

Description copied from interface: IISeriesHostListObjectFactory

Return an instance of a class that represents a data member.

Specified by:

createDataMember in interface IISeriesHostListObjectFactory