OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.TermList
Implementsosid.OsidList
Description

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

                     
                     
                     while (tl.hasNext()) {
                          Term term = tl.getNextTerm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (tl.hasNext()) {
                          Term[] terms = tl.getNextTerms(tl.available());
                     }
                     
                                 
                     
                
MethodgetNextTerm
Description

Gets the next Term in this list.

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

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

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