OSID Logo
OSID Specifications
subscription rules package
Version 3.0.0
Interfaceosid.subscription.rules.DispatchConstrainerEnablerList
Implementsosid.OsidList
Used Byosid.subscription.rules.DispatchConstrainerEnablerLookupSession
osid.subscription.rules.DispatchConstrainerEnablerPublisherSession
osid.subscription.rules.DispatchConstrainerEnablerQuerySession
osid.subscription.rules.DispatchConstrainerEnablerRuleLookupSession
osid.subscription.rules.DispatchConstrainerEnablerSearchResults
Description

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

while (cel.hasNext()) {
     DispatchConstrainerEnabler enabler = cel.getNextDispatchConstrainerEnabler();
}

or

while (cel.hasNext()) {
     DispatchConstrainerEnabler[] enablers = cel.getNextDispatchConstrainerEnablers(cel.available());
}            
                
MethodgetNextDispatchConstrainerEnabler
Description

Gets the next DispatchConstrainerEnabler in this list.

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

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

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