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

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

                     
                     
                     while (sl.hasNext()) {
                          Subscription subscription = sl.getNextSubscription();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sl.hasNext()) {
                          Subscription[] subscriptions = sl.getNextSubscriptions(sl.available());
                     }
                     
                                 
                     
                
MethodgetNextSubscription
Description

Gets the next Subscription in this list.

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

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

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