org.osid.calendaring.rules

Interface SupersedingEventEnablerList

All Superinterfaces:

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

public interface SupersedingEventEnablerList
extends OsidList

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

       
       
       while (seel.hasNext()) {
            SupersedingEventEnabler enabler = seel.getNextSupersedingEventEnabler();
       }
       
                   
       
  

or

       
       
       while (seel.hasNext()) {
            SupersedingEventEnabler[] enablers = seel.getNextSupersedingEventEnablers(seel.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextSupersedingEventEnabler

SupersedingEventEnabler getNextSupersedingEventEnabler()
                                                       throws OperationFailedException

Gets the next SupersedingEventEnabler in this list.

Returns:

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

getNextSupersedingEventEnablers

SupersedingEventEnabler[] getNextSupersedingEventEnablers(long n)
                                                          throws OperationFailedException

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

Parameters:

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

Returns:

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