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

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

                     
                     
                     while (pl.hasNext()) {
                          Provisionable provisionable = pl.getNextProvisionable();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pl.hasNext()) {
                          Provisionable[] provisionables = pl.getNextProvisionables(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextProvisionable
Description

Gets the next Provisionable in this list.

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

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

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