org.osid.ordering.batch

Interface ItemPeerList

All Superinterfaces:

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

public interface ItemPeerList
extends OsidList

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

       
       
       while (ipl.hasNext()) {
            ItemPeer peer = ipl.getNextItemPeer();
       }
       
                   
       
  

or

       
       
       while (ipl.hasNext()) {
            ItemPeer[] peers = ipl.getNextItemPeers(ipl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextItemPeer

ItemPeer getNextItemPeer()
                         throws OperationFailedException

Gets the next ItemPeer in this list.

Returns:

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

getNextItemPeers

ItemPeer[] getNextItemPeers(long n)
                            throws OperationFailedException

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

Parameters:

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

Returns:

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