oracle.toplink.ejb.cmp.wls11
Interface CursoredEnumerator

All Superinterfaces:

java.util.Enumeration, java.io.Serializable

public interface CursoredEnumerator

extends java.io.Serializable, java.util.Enumeration

PUBLIC

Provides a serializable object that conforms to an Enumeration while providing Cursor behaviour. This interface is returned from an EJB finder method that uses TopLink CursoredStream support.

Method Summary

void	close() Close the underlying cursor.
boolean	hasMoreElements() Answer a boolean indicating if the underlying cursor has more elements to return.
java.lang.Object	nextElement() Return the next element from the cursor.
java.util.Vector	nextElements(int numberOfElements) Return the next numberOfElements elements in the underlying cursor.

Method Detail

close

public void close()

Close the underlying cursor. This should be invoked when the user is finished using the cursor.

hasMoreElements

public boolean hasMoreElements()

Answer a boolean indicating if the underlying cursor has more elements to return.

Specified by:

hasMoreElements in interface java.util.Enumeration

Returns:

true if there still remains some object in the result set

nextElement

public java.lang.Object nextElement()

Return the next element from the cursor.

Specified by:

nextElement in interface java.util.Enumeration

Returns:

The next object in the result set

nextElements

public java.util.Vector nextElements(int numberOfElements)

Return the next numberOfElements elements in the underlying cursor.

Parameters:

numberOfElements - the number of objects to consume from the result set

Returns:

The Vector of objects that were consumed from the result set