Interface CanonicalUnitBatchFormList

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

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

while (cubfl.hasNext()) {
     CanonicalUnitBatchForm form = cubfl.getNextCanonicalUnitBatchForm();
}
or 
while (cubfl.hasNext()) {
     CanonicalUnitBatchForm[] forms = cubfl.getNextCanonicalUnitBatchForms(cubfl.available());
}

  • Method Details

    • getNextCanonicalUnitBatchForm

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

    • getNextCanonicalUnitBatchForms

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