org.osid.search

Interface EngineNodeList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface EngineNodeList
extends OsidList

Like all OsidLists, EngineNodeList provides a means for accessing EngineNode elements sequentially either one at a time or many at a time. Examples:

       
       
       while (enl.hasNext()) {
            EngineNode node = enl.getNextEngineNode();
       }
       
                   
       
  

or

       
       
       while (enl.hasNext()) {
            EngineNode[] nodes = enl.getNextEngineNodes(enl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
EngineNode	getNextEngineNode() Gets the next EngineNode in this list.
EngineNode[]	getNextEngineNodes(long n) Gets the next set of EngineNode elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextEngineNode

EngineNode getNextEngineNode()
                             throws OperationFailedException

Gets the next EngineNode in this list.

Returns:

the next EngineNode in this list. The hasNext() method should be used to test that a next EngineNode is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextEngineNodes

EngineNode[] getNextEngineNodes(long n)
                                throws OperationFailedException

Gets the next set of EngineNode elements in this list. The specified amount must be less than or equal to the return from available().

Parameters:

n - the number of EngineNode elements requested which must be less than or equal to available()

Returns:

an array of EngineNode elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.