org.osid.subscription.rules

Interface SubscriptionEnablerList

All Superinterfaces:

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

public interface SubscriptionEnablerList
extends OsidList

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

Method Summary

Methods

Modifier and Type	Method and Description
SubscriptionEnabler	getNextSubscriptionEnabler() Gets the next SubscriptionEnabler in this list.
SubscriptionEnabler[]	getNextSubscriptionEnablers(long n) Gets the next set of SubscriptionEnabler 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

getNextSubscriptionEnabler

SubscriptionEnabler getNextSubscriptionEnabler()
                                               throws OperationFailedException

Gets the next SubscriptionEnabler in this list.

Returns:

the next SubscriptionEnabler in this list. The hasNext() method should be used to test that a next SubscriptionEnabler 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.

getNextSubscriptionEnablers

SubscriptionEnabler[] getNextSubscriptionEnablers(long n)
                                                  throws OperationFailedException

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

Parameters:

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

Returns:

an array of SubscriptionEnabler 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.