Interface CommissionBatchFormList

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

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

while (cbfl.hasNext()) {
     CommissionBatchForm form = cbfl.getNextCommissionBatchForm();
}
or 
while (cbfl.hasNext()) {
     CommissionBatchForm[] forms = cbfl.getNextCommissionBatchForms(cbfl.available());
}

  • Method Details

    • getNextCommissionBatchForm

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

    • getNextCommissionBatchForms

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