org.osid.resourcing.batch

Interface EffortPeerList

All Superinterfaces:

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

public interface EffortPeerList
extends OsidList

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

       
       
       while (epl.hasNext()) {
            EffortPeer peer = epl.getNextEffortPeer();
       }
       
                   
       
  

or

       
       
       while (epl.hasNext()) {
            EffortPeer[] peers = epl.getNextEffortPeers(epl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextEffortPeer

EffortPeer getNextEffortPeer()
                             throws OperationFailedException

Gets the next EffortPeer in this list.

Returns:

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

getNextEffortPeers

EffortPeer[] getNextEffortPeers(long n)
                                throws OperationFailedException

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

Parameters:

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

Returns:

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