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

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

                     
                     
                     while (ppl.hasNext()) {
                          ProvisionablePeer peer = ppl.getNextProvisionablePeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ppl.hasNext()) {
                          ProvisionablePeer[] peers = ppl.getNextProvisionablePeers(ppl.available());
                     }
                     
                                 
                     
                
MethodgetNextProvisionablePeer
Description

Gets the next ProvisionablePeer in this list.

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

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

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