com.ibm.ims.dli

Interface PathSet

public interface PathSet

A PathSet is only used for batch retrieval and represents a collection of Path objects, each containing the segment data returned from a database retrieve call.

A PathSet is typically used when the application expects more than one record to be retrieved in the IMS DL/I database call.

For a code example of how to use this interface, refer to the related PCB method in the Javadoc.

See Also:

PCB.batchRetrieve(SSAList)

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() Returns true if the set has more Path elements.
Path	next() Returns the next Path element in the set.
void	next(Path path) Copies the next Path element in the set into the Path object passed in.
boolean	nextCallDLI() Returns true if the next call is a DLI call.

Method Detail

hasNext

boolean hasNext()
         throws DLIException

Returns true if the set has more Path elements.

Returns:

true if the set has more Path elements.

Throws:

DLIException - if an error occurs during processing

next

Path next()
   throws DLIException

Returns the next Path element in the set. Calling this method repeatedly until the hasNext() method returns false will return each element in the underlying set exactly once.

Returns:

the next Path element in the set

Throws:

DLIException - if an error occurs during processing

next

void next(Path path)
   throws DLIException

Copies the next Path element in the set into the Path object passed in.

Parameters:

path - the element into which the next Path element in the set is copied

Throws:

DLIException - if an error occurs during processing

nextCallDLI

boolean nextCallDLI()

Returns true if the next call is a DLI call.

Returns:

true if the next call is a DLI call.