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