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

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

                     
                     
                     while (hapl.hasNext()) {
                          HoldAgentPeer peer = hapl.getNextHoldAgentPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (hapl.hasNext()) {
                          HoldAgentPeer[] peers = hapl.getNextHoldAgentPeers(hapl.available());
                     }
                     
                                 
                     
                
MethodgetNextHoldAgentPeer
Description

Gets the next HoldAgentPeer in this list.

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

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

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