OSID Logo
OSID Specifications
subscription package
Version 3.1.0
Interfaceosid.subscription.SubscriptionList
Implementsosid.OsidList
Used Byosid.subscription.MySubscriptionSession
osid.subscription.SubscriptionLookupSession
osid.subscription.SubscriptionPublisherSession
osid.subscription.SubscriptionQuerySession
osid.subscription.SubscriptionSearchResults
osid.subscription.rules.SubscriptionEnablerRuleLookupSession
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.Subscription the next Subscription in this list. The hasNext() method should be used to test that a next Subscription 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.
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().

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