OSID Logo
OSID Specifications
hold batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.batch.HoldResourcePeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (hrpl.hasNext()) {
                          HoldResourcePeer peer = hrpl.getNextHoldResourcePeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (hrpl.hasNext()) {
                          HoldResourcePeer[] peers = hrpl.getNextHoldResourcePeers(hrpl.available());
                     }
                     
                                 
                     
                
MethodgetNextHoldResourcePeer
Description

Gets the next HoldResourcePeer in this list.

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

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

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