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

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

                     
                     
                     while (ppl.hasNext()) {
                          ProvisionPeer peer = ppl.getNextProvisionPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ppl.hasNext()) {
                          ProvisionPeer[] peers = ppl.getNextProvisionPeers(ppl.available());
                     }
                     
                                 
                     
                
MethodgetNextProvisionPeer
Description

Gets the next ProvisionPeer in this list.

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

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

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