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

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

                     
                     
                     while (cl.hasNext()) {
                          Commitment commitment = cl.getNextCommitment();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cl.hasNext()) {
                          Commitment[] commitments = cl.getNextCommitment(cl.available());
                     }
                     
                                 
                     
                
MethodgetNextCommitment
Description

Gets the next Commitment in this list.

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

Gets the next set of Commitment elements in this list which must be less than or equal to the number returned from available().

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