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