Interface BinBatchFormList

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

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

while (bbfl.hasNext()) {
     BinBatchForm form = bbfl.getNextBinBatchForm();
}
or 
while (bbfl.hasNext()) {
     BinBatchForm[] forms = bbfl.getNextBinBatchForms(bbfl.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    BinBatchForm
    getNextBinBatchForm()
    Gets the next BinBatchForm in this list.
    BinBatchForm[]
    getNextBinBatchForms(long n)
    Gets the next set of BinBatchForm 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

    • getNextBinBatchForm

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

    • getNextBinBatchForms

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