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