OSID Logo
OSID Specifications
recognition package
Version 3.1.0
Interfaceosid.recognition.AcademyList
Implementsosid.OsidList
Used Byosid.recognition.AcademyHierarchySession
osid.recognition.AcademyLookupSession
osid.recognition.AcademyQuerySession
osid.recognition.AcademySearchResults
osid.recognition.AwardAcademySession
osid.recognition.ConferralAcademySession
osid.recognition.ConvocationAcademySession
Description

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

while (al.hasNext()) {
     Academy academy = al.getNextAcademy();
}
                
or
while (al.hasNext()) {
     Academy[] academies = al.getNextAcademies(al.available());
}
                
MethodgetNextAcademy
Description

Gets the next Academy in this list.

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

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

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