Interface ObjectiveBankBatchFormList

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

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

while (obbfl.hasNext()) {
     ObjectiveBankBatchForm form = obbfl.getNextObjectiveBankBatchForm();
}
or 
while (obbfl.hasNext()) {
     ObjectiveBankBatchForm[] forms = obbfl.getNextObjectiveBankBatchForms(obbfl.available());
}

  • Method Details

    • getNextObjectiveBankBatchForm

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

    • getNextObjectiveBankBatchForms

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