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