OSID Logo
OSID Specifications
hold batch package
Version 3.1.0
Interfaceosid.hold.batch.HoldPeerList
Implementsosid.OsidList
Description

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

while (hpl.hasNext()) {
     HoldPeer peer = hpl.getNextHoldPeer();
}
                
or
while (hpl.hasNext()) {
     HoldPeer[] peers = hpl.getNextHoldPeers(hpl.available());
}
                

Like all OsidLists, HoldPeerList is stateful and must not be accessed by multiple processing threads.

MethodgetNextHoldPeer
Description

Gets the next HoldPeer in this list.

Returnosid.hold.batch.HoldPeer the next HoldPeer in this list. The hasNext() method should be used to test that a next HoldPeer 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.
MethodgetNextHoldPeers
Description

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

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