org.osid.subscription

Interface SubscriptionList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface SubscriptionList
extends OsidList

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());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Subscription	getNextSubscription() Gets the next Subscription in this list.
Subscription[]	getNextSubscriptions(long n) Gets the next set of Subscription elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextSubscription

Subscription getNextSubscription()
                                 throws OperationFailedException

Gets the next Subscription in this list.

Returns:

the next Subscription in this list. The hasNext() method should be used to test that a next Subscription is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextSubscriptions

Subscription[] getNextSubscriptions(long n)
                                    throws OperationFailedException

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

Parameters:

n - the number of Subscription elements requested which must be less than or equal to available()

Returns:

an array of Subscription elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.