Rational Developer for Power Systems Software
V7.6

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

java.lang.Object
  extended by com.ibm.etools.iseries.comm.interfaces.ISeriesHostListObjectNameArrayFactory
All Implemented Interfaces:
IISeriesHostListBaseFactory, IISeriesHostListObjectFactory, IISeriesHostObjectFactory

public class ISeriesHostListObjectNameArrayFactory
extends Object
implements IISeriesHostListObjectFactory

This class is simply a factory for creating a list of name Strings only for the ISeriesListObjects API.


Field Summary
static String Copyright
           
 
Constructor Summary
ISeriesHostListObjectNameArrayFactory()
           
 
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 reset()
          Factory method called to reset the ISeriesHostObjectNameArray used.
 boolean wantToIncludeSize()
          The decision to include size in the returned information is not applicable to BRIEF or EXHAUSTIVE list requests.
 
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

ISeriesHostListObjectNameArrayFactory

public ISeriesHostListObjectNameArrayFactory()
Method Detail

wantToIncludeSize

public boolean wantToIncludeSize()
The decision to include size in the returned information is not applicable to BRIEF or EXHAUSTIVE list requests. Hence, this method always returns false.

Specified by:
wantToIncludeSize in interface IISeriesHostListObjectFactory

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

reset

public void reset()
Factory method called to reset the ISeriesHostObjectNameArray used. This must be invoked between getList... API calls


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.