OSID Logo
OSID Specifications
subscription rules package
Version 3.1.0
Interfaceosid.subscription.rules.SubscriptionEnablerList
Implementsosid.OsidList
Used Byosid.subscription.rules.SubscriptionEnablerLookupSession
osid.subscription.rules.SubscriptionEnablerPublisherSession
osid.subscription.rules.SubscriptionEnablerQuerySession
osid.subscription.rules.SubscriptionEnablerRuleLookupSession
osid.subscription.rules.SubscriptionEnablerSearchResults
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.SubscriptionEnabler the next SubscriptionEnabler in this list. The hasNext() method should be used to test that a next SubscriptionEnabler is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.