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

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

                     
                     
                     while (rtpl.hasNext()) {
                          RequestTransactionPeer peer = rtpl.getNextRequestTransactionPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rtpl.hasNext()) {
                          RequestTransactionPeer[] peers = rtpl.getNextRequestTransactionPeers(rtpl.available());
                     }
                     
                                 
                     
                
MethodgetNextRequestTransactionPeer
Description

Gets the next RequestTransactionPeer in this list.

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

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

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