org.osid.topology.batch

Interface EdgePeerList

All Superinterfaces:

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

public interface EdgePeerList
extends OsidList

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

       
       
       while (epl.hasNext()) {
            EdgePeer peer = epl.getNextEdgePeer();
       }
       
                   
       
  

or

       
       
       while (epl.hasNext()) {
            EdgePeer[] peers = epl.getNextEdgePeer(epl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
EdgePeer	getNextEdgePeer() Gets the next EdgePeer in this list.
EdgePeer[]	getNextEdgePeers(long n) Gets the next set of EdgePeer 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

getNextEdgePeer

EdgePeer getNextEdgePeer()
                         throws OperationFailedException

Gets the next EdgePeer in this list.

Returns:

the next EdgePeer in this list. The hasNext() method should be used to test that a next EdgePeer 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.

getNextEdgePeers

EdgePeer[] getNextEdgePeers(long n)
                            throws OperationFailedException

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

Parameters:

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

Returns:

an array of EdgePeer 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.