OSID Logo
OSID Specifications
calendaring rules package
Version 3.1.0
Interfaceosid.calendaring.rules.RecurringEventEnablerList
Implementsosid.OsidList
Used Byosid.calendaring.rules.RecurringEventEnablerCalendarSession
osid.calendaring.rules.RecurringEventEnablerLookupSession
osid.calendaring.rules.RecurringEventEnablerQuerySession
osid.calendaring.rules.RecurringEventEnablerRuleLookupSession
osid.calendaring.rules.RecurringEventEnablerSearchResults
Description

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

while (reel.hasNext()) {
     RecurringEventEnabler enabler = reel.getNextRecurringEventEnabler();
}
                
or
while (reel.hasNext()) {
     RecurringEventEnabler[] enablers = reel.getNextRecurringEventEnablers(reel.available());
}
                
MethodgetNextRecurringEventEnabler
Description

Gets the next RecurringEventEnabler in this list.

Returnosid.calendaring.rules.RecurringEventEnabler the next RecurringEventEnabler in this list. The hasNext() method should be used to test that a next RecurringEventEnabler 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.
MethodgetNextRecurringEventEnablers
Description

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

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