OSID Logo
OSID Specifications
course package
Version 3.1.0
Interfaceosid.course.TermList
Implementsosid.OsidList
Used Byosid.course.TermCourseCatalogSession
osid.course.TermHierarchySession
osid.course.TermLookupSession
osid.course.TermQuerySession
osid.course.TermSearchResults
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.Term the next Term in this list. The hasNext() method should be used to test that a next Term 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.
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().

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