org.osid.offering.batch

Interface OfferingPeerList

All Superinterfaces:

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

public interface OfferingPeerList
extends OsidList

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

       
       
       while (opl.hasNext()) {
            OfferingPeer peer = opl.getNextOfferingPeer();
       }
       
                   
       
  

or

       
       
       while (oopl.hasNext()) {
            OfferingPeer[] peers = opl.getNextOfferingPeers(opl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextOfferingPeer

OfferingPeer getNextOfferingPeer()
                                 throws OperationFailedException

Gets the next OfferingPeer in this list.

Returns:

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

getNextOfferingPeers

OfferingPeer[] getNextOfferingPeers(long n)
                                    throws OperationFailedException

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

Parameters:

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

Returns:

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