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

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

                     
                     
                     while (cpl.hasNext()) {
                          CommissionPeer peer = cpl.getNextCommissionPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cpl.hasNext()) {
                          CommissionPeer[] peers = cpl.getNextCommissionPeers(cpl.available());
                     }
                     
                                 
                     
                
MethodgetNextCommissionPeer
Description

Gets the next CommissionPeer in this list.

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

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

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