Interface CompositionBatchFormList

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

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

while (cbfl.hasNext()) {
     CompositionBatchForm form = cbfl.getNextCompositionBatchForm();
}
or 
while (cbfl.hasNext()) {
     CompositionBatchForm[] forms = cbfl.getNextCompositionBatchForms(cbfl.available());
}

  • Method Details

    • getNextCompositionBatchForm

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

    • getNextCompositionBatchForms

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