OSID Logo
OSID Specifications
checklist package
Version 3.1.0
Interfaceosid.checklist.TodoList
Implementsosid.OsidList
Used Byosid.checklist.Todo
osid.checklist.TodoChecklistSession
osid.checklist.TodoHierarchySession
osid.checklist.TodoLookupSession
osid.checklist.TodoQuerySession
osid.checklist.TodoSearchResults
Description

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

while (tl.hasNext()) {
     Todo todo =tcl.getNextTodo();
}
                
or
while (tl.hasNext()) {
     Todo[] todos = tl.getNextTodos(tl.available());
}
                
MethodgetNextTodo
Description

Gets the next Todo in this list.

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

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

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