OSID Logo
OSID Specifications
calendaring rules package
Version 3.1.0
Interfaceosid.calendaring.rules.SupersedingEventEnablerList
Implementsosid.OsidList
Used Byosid.calendaring.rules.SupersedingEventEnablerCalendarSession
osid.calendaring.rules.SupersedingEventEnablerLookupSession
osid.calendaring.rules.SupersedingEventEnablerQuerySession
osid.calendaring.rules.SupersedingEventEnablerRuleLookupSession
osid.calendaring.rules.SupersedingEventEnablerSearchResults
Description

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

while (seel.hasNext()) {
     SupersedingEventEnabler enabler = seel.getNextSupersedingEventEnabler();
}
                
or
while (seel.hasNext()) {
     SupersedingEventEnabler[] enablers = seel.getNextSupersedingEventEnablers(seel.available());
}
                
MethodgetNextSupersedingEventEnabler
Description

Gets the next SupersedingEventEnabler in this list.

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

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

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