Interface | osid.messaging.MailboxList | ||
---|---|---|---|
Implements | osid.OsidList | ||
Description |
Like all while (ml.hasNext()) { Mailbox mailbox = ml.getNextMailbox(); }or while (ml.hasNext()) { Mailbox[] mailboxes = ml.getNextMailboxes(ml.available()); } | ||
Method | getNextMailbox | ||
Description |
Gets the next | ||
Return | osid.messaging.Mailbox | the next Mailbox in this list. The hasNext()
method should be used to test that a next Mailbox is available
before calling this method. | |
Errors | ILLEGAL_STATE | no more elements available in this list | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getNextMailboxes | ||
Description |
Gets the next set of | ||
Parameters | cardinal | n | the number of Mailbox elements requested which must be less
than or equal to available() |
Return | osid.messaging.Mailbox[] | an array of Mailbox elements. The length of
the array is less than or equal to the number specified. | |
Errors | ILLEGAL_STATE | no more elements available in this list | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. |