org.osid.billing.batch

Interface CustomerBatchFormList

All Superinterfaces:

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

public interface CustomerBatchFormList
extends OsidList

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

       
       
       while (cbfl.hasNext()) {
            CustomerBatchForm form = cbfl.getNextCustomerBatchForm();
       }
       
                   
       
  

or

       
       
       while (cbfl.hasNext()) {
            CustomerBatchForm[] forms = cbfl.getNextCustomerBatchForms(cbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextCustomerBatchForm

CustomerBatchForm getNextCustomerBatchForm()
                                           throws OperationFailedException

Gets the next CustomerBatchForm in this list.

Returns:

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

getNextCustomerBatchForms

CustomerBatchForm[] getNextCustomerBatchForms(long n)
                                              throws OperationFailedException

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

Parameters:

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

Returns:

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