Interface IngredientBatchFormList

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

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

while (ibfl.hasNext()) {
     IngredientBatchForm form = ibfl.getNextIngredientBatchForm();
}
or 
while (ibfl.hasNext()) {
     IngredientBatchForm[] forms = ibfl.getNextIngredientBatchForms(ibfl.available());
}

  • Method Details

    • getNextIngredientBatchForm

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

    • getNextIngredientBatchForms

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