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