OSID Logo
OSID Specifications
subscription rules package
Version 3.0.0
Interfaceosid.subscription.rules.DispatchProcessorList
Implementsosid.OsidList
Used Byosid.subscription.rules.DispatchProcessorEnablerRuleLookupSession
osid.subscription.rules.DispatchProcessorLookupSession
osid.subscription.rules.DispatchProcessorPublisherSession
osid.subscription.rules.DispatchProcessorQuerySession
osid.subscription.rules.DispatchProcessorRuleLookupSession
osid.subscription.rules.DispatchProcessorSearchResults
Description

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

while (pl.hasNext()) {
     DispatchProcessor processor = pl.getNextDispatchProcessor();
}

or

while (pl.hasNext()) {
     DispatchProcessor[] processors = pl.getNextDispatchProcessors(pl.available());
}            
                
MethodgetNextDispatchProcessor
Description

Gets the next DispatchProcessor in this list.

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

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

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