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