org.osid.checklist.mason

Interface TodoProducerList

All Superinterfaces:

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

public interface TodoProducerList
extends OsidList

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

       
       
       while (tpel.hasNext()) {
            TodoProducer producer = tpel.getNextTodoProducer();
       }
       
                   
       
  

or

       
       
       while (tpel.hasNext()) {
            TodoProducer[] producers = tpel.getNextTodoProducers(tpel.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
TodoProducer	getNextTodoProducer() Gets the next TodoProducer in this list.
TodoProducer[]	getNextTodoProducers(long n) Gets the next set of TodoProducer elements in this list.

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

getNextTodoProducer

TodoProducer getNextTodoProducer()
                                 throws OperationFailedException

Gets the next TodoProducer in this list.

Returns:

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

getNextTodoProducers

TodoProducer[] getNextTodoProducers(long n)
                                    throws OperationFailedException

Gets the next set of TodoProducer elements in this list. The specified amount must be less than or equal to the return from available().

Parameters:

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

Returns:

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