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

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

                     
                     
                     while (cel.hasNext()) {
                          CommitmentEnabler enabler = cel.getNextCommitmentEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cel.hasNext()) {
                          CommitmentEnabler[] enablers = cel.getNextCommitmentEnablers(cel.available());
                     }
                     
                                 
                     
                
MethodgetNextCommitmentEnabler
Description

Gets the next CommitmentEnabler in this list.

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

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

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