org.osid.acknowledgement.batch

Interface CreditPeerList

All Superinterfaces:

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

public interface CreditPeerList
extends OsidList

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

       
       
       while (cpl.hasNext()) {
            CreditPeer peer = cpl.getNextCreditPeer();
       }
       
                   
       
  

or

       
       
       while (cpl.hasNext()) {
            CreditPeer[] peers = cpl.getNextCreditPeers(cpl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextCreditPeer

CreditPeer getNextCreditPeer()
                             throws OperationFailedException

Gets the next CreditPeer in this list.

Returns:

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

getNextCreditPeers

CreditPeer[] getNextCreditPeers(long n)
                                throws OperationFailedException

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

Parameters:

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

Returns:

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