OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.PersonList
Implementsosid.OsidList
Description

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

                     
                     
                     while (pl.hasNext()) {
                          Person person = pl.getNextPerson();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pl.hasNext()) {
                          Person[] persons = pl.getNextPersons(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextPerson
Description

Gets the next Person in this list.

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

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

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