OSID Logo
OSID Specifications
checklist mason package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.mason.TodoProducerList
Implementsosid.OsidList
Description

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());
                     }
                     
                                 
                     
                
MethodgetNextTodoProducer
Description

Gets the next TodoProducer in this list.

Returnosid.checklist.mason.TodoProducerthe next TodoProducer in this list. The hasNext() method should be used to test that a next TodoProducer is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextTodoProducers
Description

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

Parameterscardinalnthe number of TodoProducer elements requested which must be less than or equal to available()
Returnosid.checklist.mason.TodoProducer[]an array of TodoProducer elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.