Interface OublietteBatchFormList

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

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

while (obfl.hasNext()) {
     OublietteBatchForm form = obfl.getNextOublietteBatchForm();
}
or 
while (obfl.hasNext()) {
     OublietteBatchForm[] forms = obfl.getNextOublietteBatchForms(obfl.available());
}

  • Method Details

    • getNextOublietteBatchForm

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

    • getNextOublietteBatchForms

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