org.osid.room.squatting.batch

Interface DeedPeerList

All Superinterfaces:

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

public interface DeedPeerList
extends OsidList

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

       
       
       while (dpl.hasNext()) {
            DeedPeer peer = dpl.getNextDeedPeer();
       }
       
                   
       
  

or

       
       
       while (dpl.hasNext()) {
            DeedPeer[] peers = dpl.getNextDeedPeers(dpl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextDeedPeer

DeedPeer getNextDeedPeer()
                         throws OperationFailedException

Gets the next DeedPeer in this list.

Returns:

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

getNextDeedPeers

DeedPeer[] getNextDeedPeers(long n)
                            throws OperationFailedException

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

Parameters:

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

Returns:

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