OSID Logo
OSID Specifications
calendaring rules package
Version 3.1.0
Interfaceosid.calendaring.rules.CommitmentEnablerList
Implementsosid.OsidList
Used Byosid.calendaring.rules.CommitmentEnablerCalendarSession
osid.calendaring.rules.CommitmentEnablerLookupSession
osid.calendaring.rules.CommitmentEnablerQuerySession
osid.calendaring.rules.CommitmentEnablerRuleLookupSession
osid.calendaring.rules.CommitmentEnablerSearchResults
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.CommitmentEnabler the next CommitmentEnabler in this list. The hasNext() method should be used to test that a next CommitmentEnabler is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.