OSID Logo
OSID Specifications
subscription rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.rules.SubscriptionEnablerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (sel.hasNext()) {
                          SubscriptionEnabler enabler = sel.getNextSubscriptionEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sel.hasNext()) {
                          SubscriptionEnabler[] enablers = sel.getNextSubscriptionEnablers sel.available());
                     }
                     
                                 
                     
                
MethodgetNextSubscriptionEnabler
Description

Gets the next SubscriptionEnabler in this list.

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

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

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