OSID Logo
OSID Specifications
checklist package
Version 3.1.0
Interfaceosid.checklist.ChecklistList
Implementsosid.OsidList
Used Byosid.checklist.ChecklistHierarchySession
osid.checklist.ChecklistLookupSession
osid.checklist.ChecklistQuerySession
osid.checklist.ChecklistSearchResults
osid.checklist.TodoChecklistSession
osid.checklist.mason.TodoProducerChecklistSession
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.Checklist the next Checklist in this list. The hasNext() method should be used to test that a next Checklist is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.