org.osid.resourcing.batch

Interface CommissionPeerList

All Superinterfaces:

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

public interface CommissionPeerList
extends OsidList

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

       
       
       while (cpl.hasNext()) {
            CommissionPeer peer = cpl.getNextCommissionPeer();
       }
       
                   
       
  

or

       
       
       while (cpl.hasNext()) {
            CommissionPeer[] peers = cpl.getNextCommissionPeers(cpl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextCommissionPeer

CommissionPeer getNextCommissionPeer()
                                     throws OperationFailedException

Gets the next CommissionPeer in this list.

Returns:

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

getNextCommissionPeers

CommissionPeer[] getNextCommissionPeers(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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