org.osid.billing.payment

Interface PayerList

All Superinterfaces:

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

public interface PayerList
extends OsidList

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

       
       
       while (pl.hasNext()) {
            Payer payer = pl.getNextPayer();
       }
       
                   
       
  

or

       
       
       while (pl.hasNext()) {
            Payer[] payers = pl.getNextPayers(pl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextPayer

Payer getNextPayer()
                   throws OperationFailedException

Gets the next Payer in this list.

Returns:

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

getNextPayers

Payer[] getNextPayers(long n)
                      throws OperationFailedException

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

Parameters:

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

Returns:

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