| Interface | osid.recognition.AwardList | ||
|---|---|---|---|
| Implements | osid.OsidList | ||
| Used By | osid.recognition.AwardAcademySession | ||
osid.recognition.AwardLookupSession | |||
osid.recognition.AwardQuerySession | |||
osid.recognition.AwardSearchResults | |||
osid.recognition.Convocation | |||
| Description |
Like all while (al.hasNext()) {
Award award = al.getNextAward();
}
or
while (al.hasNext()) {
Award[] awards = al.getNextAwards(al.available());
}
| ||
| Method | getNextAward | ||
| Description |
Gets the next | ||
| Return | osid.recognition.Award | the next Award in this list. The hasNext()
method should be used to test that a next Award is available
before calling this method. | |
| Errors | ILLEGAL_STATE | no more elements available in this list | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getNextAwards | ||
| Description |
Gets the next set of | ||
| Parameters | cardinal | n | the number of Award elements requested which must be less
than or equal to available() |
| Return | osid.recognition.Award[] | an array of Award elements. The length of the array is less
than or equal to the number specified. | |
| Errors | ILLEGAL_STATE | no more elements available in this list | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |