OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.AwardList
Implementsosid.OsidList
Description

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

                     
                     
                     while (al.hasNext()) {
                          Award award = al.getNextAward();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (al.hasNext()) {
                          Award[] awards = al.getNextAwards(al.available());
                     }
                     
                                 
                     
                
MethodgetNextAward
Description

Gets the next Award in this list.

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

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

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