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

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

                     
                     
                     while (pl.hasNext()) {
                          Position position = pl.getNextPosition();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pl.hasNext()) {
                          Position[] positions = pl.getNextPositions(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextPosition
Description

Gets the next Position in this list.

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

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

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