org.osid.financials.posting.batch

Interface PostBatchFormList

All Superinterfaces:

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

public interface PostBatchFormList
extends OsidList

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

       
       
       while (pbfl.hasNext()) {
            PostBatchForm form = pbfl.getNextPostBatchForm();
       
                   
       
  

or

       
       
       while (pbfl.hasNext()) {
            PostBatchForm[] forms = pbfl.getNextPostBatchForms(pbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextPostBatchForm

PostBatchForm getNextPostBatchForm()
                                   throws OperationFailedException

Gets the next PostBatchForm in this list.

Returns:

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

getNextPostBatchForms

PostBatchForm[] getNextPostBatchForms(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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