Interface BookBatchFormList

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

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

while (bbfl.hasNext()) {
     BookBatchForm form = bbfl.getNextBookBatchForm();
}
or 
while (bbfl.hasNext()) {
     BookBatchForm[] forms = bbfl.getNextBookBatchForms(bbfl.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    BookBatchForm
    getNextBookBatchForm()
    Gets the next BookBatchForm in this list.
    BookBatchForm[]
    getNextBookBatchForms(long n)
    Gets the next set of BookBatchForm elements in this list.

    Methods inherited from interface Closeable

    close

    Methods inherited from interface OsidList

    close
    Modifier and Type
    Method
    Description
    void
    close()
    Close this list.

    Methods inherited from interface OsidList

    available, hasNext, skip
    Modifier and Type
    Method
    Description
    long
    available()
    Gets the number of elements available for retrieval.
    boolean
    hasNext()
    Tests if there are more elements in this list.
    void
    skip(long n)
    Skip the specified number of elements in the list.

  • Method Details

    • getNextBookBatchForm

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

    • getNextBookBatchForms

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