OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.ProvisionList
Implementsosid.OsidList
Description

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

                     
                     
                     while (pl.hasNext()) {
                          Provision provision = pl.getNextProvision();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pl.hasNext()) {
                          Provision[] provisions = pl.getNextProvisions(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextProvision
Description

Gets the next Provision in this list.

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

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

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