OSID Logo
OSID Specifications
subscription rules package
Version 3.0.0
Interfaceosid.subscription.rules.DispatchProcessorEnablerList
Implementsosid.OsidList
Used Byosid.subscription.rules.DispatchProcessorEnablerLookupSession
osid.subscription.rules.DispatchProcessorEnablerPublisherSession
osid.subscription.rules.DispatchProcessorEnablerQuerySession
osid.subscription.rules.DispatchProcessorEnablerRuleLookupSession
osid.subscription.rules.DispatchProcessorEnablerSearchResults
Description

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

while (pel.hasNext()) {
     DispatchProcessorEnabler enabler = pel.getNextDispatchProcessorEnabler();
}

or

while (pel.hasNext()) {
     DispatchProcessorEnabler[] enablers = pel.getNextDispatchProcessorEnablers(pel.available());
}            
                
MethodgetNextDispatchProcessorEnabler
Description

Gets the next DispatchProcessorEnabler in this list.

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

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

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