org.osid.messaging

Interface MessageList

All Superinterfaces:

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

public interface MessageList
extends OsidList

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

       
       
       while (ml.hasNext()) {
            Message message = ml.getNextMessage();
       }
       
                   
       
  

or

       
       
       while (ml.hasNext()) {
            Message[] messages = ml.getNextMessages(ml.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextMessage

Message getNextMessage()
                       throws OperationFailedException

Gets the next Message in this list.

Returns:

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

getNextMessages

Message[] getNextMessages(long n)
                          throws OperationFailedException

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

Parameters:

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

Returns:

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