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

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

                     
                     
                     while (cl.hasNext()) {
                          Checklist checklist = cl.getNextChecklist();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cl.hasNext()) {
                          Checklist[] checklist = cl.getNextChecklists(cl.available());
                     }
                     
                                 
                     
                
MethodgetNextChecklist
Description

Gets the next Checklist in this list.

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

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

Parameterscardinalnthe number of Checklist elements requested which must be less than or equal to available()
Returnosid.checklist.Checklist[]an array of Checklist 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.