OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.AvailabilityList
Implementsosid.OsidList
Description

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

                     
                     
                     while (al.hasNext()) {
                          Availability availability = al.getNextAvailability();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (al.hasNext()) {
                          Availability[] availabilities = al.getNextAvailabilitys(al.available());
                     }
                     
                                 
                     
                
MethodgetNextAvailability
Description

Gets the next Availability in this list.

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

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

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