public interface RecipeBatchFormList extends OsidList
Like all OsidLists,
RecipeBatchFormList
provides a means for accessing RecipeBatchForm
elements
sequentially either one at a time or many at a time. Examples:
while (rbfl.hasNext()) { RecipeBatchForm form = rbfl.getNextRecipeBatchForm(); }or
while (rbfl.hasNext()) { RecipeBatchForm[] forms = rbfl.getNextRecipeBatchForms(rbfl.available()); }
Modifier and Type | Method and Description |
---|---|
RecipeBatchForm |
getNextRecipeBatchForm()
Gets the next
RecipeBatchForm in this list. |
RecipeBatchForm[] |
getNextRecipeBatchForms(long n)
Gets the next set of
RecipeBatchForm elements in this
list. |
RecipeBatchForm getNextRecipeBatchForm() throws OperationFailedException
RecipeBatchForm
in this list. RecipeBatchForm
in this list. The
hasNext()
method should be used to test that a
next RecipeBatchForm
is available before
calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. RecipeBatchForm[] getNextRecipeBatchForms(long n) throws OperationFailedException
RecipeBatchForm
elements in this
list. The specified amount must be less than or equal to the return
from available().
n
- the number of RecipeBatchForm
elements
requested which must be less than or equal to
available()
RecipeBatchForm
elements.
The length of the array is less than or equal to the
number specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.