OSID - osid.billing.payment.PaymentList Service Interface Definition

Interface	osid.billing.payment.PaymentList
Implements	`osid.OsidList`
Used By	`osid.billing.payment.PaymentBusinessSession`
	`osid.billing.payment.PaymentLookupSession`
	`osid.billing.payment.PaymentQuerySession`
	`osid.billing.payment.PaymentSearchResults`
Description	Like all `OsidLists` , `PaymentList` provides a means for accessing `Payment` elements sequentially either one at a time or many at a time. Examples: while (pl.hasNext()) { Payment payment = pl.getNextPayment(); } or while (pl.hasNext()) { Payment[] payments = pl.getNextPayments(pl.available()); }
Method	getNextPayment
Description	Gets the next `Payment` in this list.
Return	`osid.billing.payment.Payment`		the next `Payment` in this list. The `hasNext()` method should be used to test that a next `Payment` is available before calling this method.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getNextPayments
Description	Gets the next set of `Payment` elements in this list. The specified amount must be less than or equal to the return from `available()` .
Parameters	`cardinal`	`n`	the number of `Payment` elements requested which must be less than or equal to `available()`
Return	`osid.billing.payment.Payment[]`		an array of `Payment` elements. The length of the array is less than or equal to the number specified.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.