OSID Logo
OSID Specifications
subscription rules package
Version 3.0.0
Interfaceosid.subscription.rules.DispatchEnablerList
Implementsosid.OsidList
Used Byosid.subscription.rules.DispatchConstrainerEnablerLookupSession
osid.subscription.rules.DispatchEnablerLookupSession
osid.subscription.rules.DispatchEnablerPublisherSession
osid.subscription.rules.DispatchEnablerQuerySession
osid.subscription.rules.DispatchEnablerRuleLookupSession
osid.subscription.rules.DispatchEnablerSearchResults
Description

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

while (el.hasNext()) {
     DispatchEnabler enabler = el.getNextDispatchEnabler();
}

or

while (el.hasNext()) {
     DispatchEnabler[] enablers = el.getNextDispatchEnablers(el.available());
}            
                
MethodgetNextDispatchEnabler
Description

Gets the next DispatchEnabler in this list.

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

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

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