OSID Logo
OSID Specifications
rules check package
Version 3.1.0
Interfaceosid.rules.check.AgendaList
Implementsosid.OsidList
Used Byosid.rules.check.AgendaEngineSession
osid.rules.check.AgendaLookupSession
osid.rules.check.AgendaQuerySession
osid.rules.check.AgendaSearchResults
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.Agenda the next Agenda in this list. The hasNext() method should be used to test that a next Agenda 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.
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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.