Interface NodeBatchFormList

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

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

while (cbfl.hasNext()) {
     NodeBatchForm form = cbfl.getNextNodeBatchForm();
}
or 
while (cbfl.hasNext()) {
     NodeBatchForm[] forms = cbfl.getNextNodeBatchForms(cbfl.available());
}

  • Method Summary

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

    • getNextNodeBatchForm

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

    • getNextNodeBatchForms

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