OSID Logo
OSID Specifications
resourcing batch package
Version 3.1.0
Interfaceosid.resourcing.batch.AvailabilityPeerList
Implementsosid.OsidList
Description

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

while (apl.hasNext()) {
     AvailabilityPeer peer = apl.getNextAvailabilityPeer();
}
                
or
while (apl.hasNext()) {
     AvailabilityPeer[] peers = apl.getNextAvailabilityPeers(apl.available());
}
                
MethodgetNextAvailabilityPeer
Description

Gets the next AvailabilityPeer in this list.

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

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

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