OSID Logo
OSID Specifications
subscription rules package
Version 3.0.0
Interfaceosid.subscription.rules.DispatchConstrainerList
Implementsosid.OsidList
Used Byosid.subscription.rules.DispatchConstrainerEnablerRuleLookupSession
osid.subscription.rules.DispatchConstrainerLookupSession
osid.subscription.rules.DispatchConstrainerPublisherSession
osid.subscription.rules.DispatchConstrainerQuerySession
osid.subscription.rules.DispatchConstrainerRuleLookupSession
osid.subscription.rules.DispatchConstrainerSearchResults
Description

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

while (cl.hasNext()) {
     DispatchConstrainer constrainer = cl.getNextDispatchConstrainer();
}

or

while (cl.hasNext()) {
     DispatchConstrainer[] constrainers = cl.getNextDispatchConstrainers(cl.available());
}            
                
MethodgetNextDispatchConstrainer
Description

Gets the next DispatchConstrainer in this list.

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

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

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