Interface FloorBatchFormList

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

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

while (fbfl.hasNext()) {
     FloorBatchForm form = fbfl.getNextFloorBatchForm();
}
or 
while (fbfl.hasNext()) {
     FloorBatchForm[] forms = fbfl.getNextFloorBatchForms(fbfl.available());
}

Like all OsidLists, FloorBatchFormList is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getNextFloorBatchForm

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

    • getNextFloorBatchForms

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