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

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

                     
                     
                     while (ael.hasNext()) {
                          AwardEntry entry = ael.getNextAwardEntry();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ael.hasNext()) {
                          AwardEntry[] entries = ael.getNextAwardEntries(ael.available());
                     }
                     
                                 
                     
                
MethodgetNextAwardEntry
Description

Gets the next AwardEntry in this list.

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

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

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