OSID Logo
OSID Specifications
provisioning batch package
Version 3.1.0
Interfaceosid.provisioning.batch.RequestPeerList
Implementsosid.OsidList
Description

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

while (rpl.hasNext()) {
     RequestPeer peer = rpl.getNextRequestPeer();
}
                
or
while (rpl.hasNext()) {
     RequestPeer[] peers = rpl.getNextRequestPeers(rpl.available());
}
                
MethodgetNextRequestPeer
Description

Gets the next RequestPeer in this list.

Returnosid.provisioning.batch.RequestPeer the next RequestPeer in this list. The hasNext() method should be used to test that a next RequestPeer is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextRequestPeers
Description

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

Parameterscardinaln the number of RequestPeer elements requested which must be less than or equal to available()
Returnosid.provisioning.batch.RequestPeer[] an array of RequestPeer elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.