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

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

                     
                     
                     while (cbfl.hasNext()) {
                          CommitmentBatchForm form = cbfl.getNextCommitmentBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cbfl.hasNext()) {
                          CommitmentBatchForm[] forms = cbfl.getNextCommitmentBatchForms(cbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextCommitmentBatchForm
Description

Gets the next CommitmentBatchForm in this list.

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

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

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