org.osid.billing.batch

Interface EntryPeerList

All Superinterfaces:

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

public interface EntryPeerList
extends OsidList

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

       
       
       while (epl.hasNext()) {
            EntryPeer peer = epl.getNextEntryPeer();
       }
       
                   
       
  

or

       
       
       while (epl.hasNext()) {
            EntryPeer[] peers = epl.getNextEntryPeers(spl.available());
       e
       
                   
       
  

Method Summary

Methods

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

getNextEntryPeer

EntryPeer getNextEntryPeer()
                           throws OperationFailedException

Gets the next EntryPeer in this list.

Returns:

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

getNextEntryPeers

EntryPeer[] getNextEntryPeers(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

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