OSID Logo
OSID Specifications
resourcing batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.batch.EffortPeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (epl.hasNext()) {
                          EffortPeer peer = epl.getNextEffortPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (epl.hasNext()) {
                          EffortPeer[] peers = epl.getNextEffortPeers(epl.available());
                     }
                     
                                 
                     
                
MethodgetNextEffortPeer
Description

Gets the next EffortPeer in this list.

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

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

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