Interface PaymentBatchFormList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
public interface PaymentBatchFormList extends OsidList

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

while (pbfl.hasNext()) {
     PaymentBatchForm form = pbfl.getNextPaymentBatchForm();
}
or 
while (pbfl.hasNext()) {
     PaymentBatchForm[] forms = pbfl.getNextPaymentBatchForms(pbfl.available());
}

  • Method Details

    • getNextPaymentBatchForm

      PaymentBatchForm getNextPaymentBatchForm() throws OperationFailedException
      Gets the next PaymentBatchForm in this list.
      Returns:
      the next PaymentBatchForm in this list. The hasNext() method should be used to test that a next PaymentBatchForm 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.

    • getNextPaymentBatchForms

      PaymentBatchForm[] getNextPaymentBatchForms(long n) throws OperationFailedException
      Gets the next set of PaymentBatchForm elements in this list. The specified amount must be less than or equal to the return from available() .
      Parameters:
      n - the number of PaymentBatchForm elements requested which must be less than or equal to available()
      Returns:
      an array of PaymentBatchForm 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.