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