org.osid.messaging

Interface MailboxNodeList

All Superinterfaces:

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

public interface MailboxNodeList
extends OsidList

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

       
       
       while (mnl.hasNext()) {
            MailboxNode node = mnl.getNextMailboxNode();
       }
       
                   
       
  

or

       
       
       while (mnl.hasNext()) {
            MailboxNode[] nodes = mnl.getNextMailboxNodes(mnl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
MailboxNode	getNextMailboxNode() Gets the next MailboxNode in this list.
MailboxNode[]	getNextMailboxNodes(long n) Gets the next set of MailboxNode 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

getNextMailboxNode

MailboxNode getNextMailboxNode()
                               throws OperationFailedException

Gets the next MailboxNode in this list.

Returns:

the next MailboxNode in this list. The hasNext() method should be used to test that a next MailboxNode 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.

getNextMailboxNodes

MailboxNode[] getNextMailboxNodes(long n)
                                  throws OperationFailedException

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

Parameters:

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

Returns:

an array of MailboxNode 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.