OSID Logo
OSID Specifications
course package
Version 3.1.0
Interfaceosid.course.ActivityUnitList
Implementsosid.OsidList
Used Byosid.course.ActivityUnitCourseCatalogSession
osid.course.ActivityUnitLookupSession
osid.course.ActivityUnitQuerySession
osid.course.ActivityUnitSearchResults
Description

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

while (aul.hasNext()) {
     ActivityUnit unit = aul.getNextActivityUnit();
}
                
or
while (aul.hasNext()) {
     ActivityUnit[] units = aul.getNextActivityUnits(aul.available());
}
                
MethodgetNextActivityUnit
Description

Gets the next ActivityUnit in this list.

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

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

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