OSID Logo
OSID Specifications
calendaring batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.batch.CommitmentPeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (cpl.hasNext()) {
                          CommitmentPeer peer = cpl.getNextCommitmentPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cpl.hasNext()) {
                          CommitmentPeer[] peers = cpl.getNextCommitmentPeers(cpl.available());
                     }
                     
                                 
                     
                
MethodgetNextCommitmentPeer
Description

Gets the next CommitmentPeer in this list.

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

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

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