Interface DocetBatchFormList

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

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

while (dbfl.hasNext()) {
     DocetBatchForm form = dbfl.getNextDocetBatchForm();
}
or 
while (dbfl.hasNext()) {
     DocetBatchForm[] forms = dbfl.getNextDocetBatchForms(dbfl.available());
}

  • Method Summary

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

    • getNextDocetBatchForm

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

    • getNextDocetBatchForms

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