OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.AgendaList
Implementsosid.OsidList
Description

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

                     
                     
                     while (al.hasNext()) {
                          Agenda agenda = al.getNextAgenda();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (al.hasNext()) {
                          Agenda[] agendas = al.getNextAgendas(al.available());
                     }
                     
                                 
                     
                
MethodgetNextAgenda
Description

Gets the next Agenda in this list.

Returnosid.rules.check.Agendathe next Agenda in this list. The hasNext() method should be used to test that a next Agenda is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextAgendas
Description

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

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