OSID Logo
OSID Specifications
course syllabus package
Version 3.1.0
Interfaceosid.course.syllabus.ModuleList
Implementsosid.OsidList
Used Byosid.course.plan.Plan
osid.course.syllabus.ModuleCourseCatalogSession
osid.course.syllabus.ModuleLookupSession
osid.course.syllabus.ModuleQuerySession
osid.course.syllabus.ModuleSearchResults
Description

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

while (ml.hasNext()) {
     Module module = ml.getNextModule();
}
                
or
while (ml.hasNext()) {
     Module[] modules = ml.getNextModules(ml.available());
}
                
MethodgetNextModule
Description

Gets the next Module in this list.

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

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

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