Interface ResourceBatchFormList

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

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

while (rbfl.hasNext()) {
     ResourceBatchForm form = rbfl.getNextResourceBatchForm();
}
or 
while (rbfl.hasNext()) {
     ResourceBatchForm[] forms = rbfl.getNextResourceBatchForms(rbfl.available());
}

  • Method Details

    • getNextResourceBatchForm

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

    • getNextResourceBatchForms

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