Interface TermBatchFormList

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

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

while (tbfl.hasNext()) {
     TermBatchForm form = tbfl.getNextTermBatchForm();
}
or 
while (tbfl.hasNext()) {
     TermBatchForm[] forms = tbfl.getNextTermBatchForms(tbfl.available());
}

  • Method Summary

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

    • getNextTermBatchForm

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

    • getNextTermBatchForms

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