org.osid.messaging

Interface MailboxList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface MailboxList
extends OsidList

Like all OsidLists, MailboxList provides a means for accessing Mailbox elements sequentially either one at a time or many at a time. Examples:

       
       
       while (ml.hasNext()) {
            Mailbox mailbox = ml.getNextMailbox();
       }
       
                   
       
  

or

       
       
       while (ml.hasNext()) {
            Mailbox[] mailboxes = ml.getNextMailboxes(ml.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Mailbox	getNextMailbox() Gets the next Mailbox in this list.
Mailbox[]	getNextMailboxes(long n) Gets the next set of Mailbox elements in this list which must be less than or equal to the return from available().

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextMailbox

Mailbox getNextMailbox()
                       throws OperationFailedException

Gets the next Mailbox in this list.

Returns:

the next Mailbox in this list. The hasNext() method should be used to test that a next Mailbox is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextMailboxes

Mailbox[] getNextMailboxes(long n)
                           throws OperationFailedException

Gets the next set of Mailbox elements in this list which must be less than or equal to the return from available().

Parameters:

n - the number of Mailbox elements requested which must be less than or equal to available()

Returns:

an array of Mailbox elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.