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