org.osid.calendaring

Interface SupersedingEventList

All Superinterfaces:

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

public interface SupersedingEventList
extends OsidList

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

       
       
       while (sel.hasNext()) {
            SupersedingEvent event = sel.getNextSupersedingEvent();
       }
       
                   
       
  

or

       
       
       while (sel.hasNext()) {
            SupersedingEvent[] events = sel.getNextSupersedingEvents(sel.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
SupersedingEvent	getNextSupersedingEvent() Gets the next SupersedingEvent in this list.
SupersedingEvent[]	getNextSupersedingEvents(long n) Gets the next set of SupersedingEvent elements in this list which must be less than or equal to the number returned from available().

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

getNextSupersedingEvent

SupersedingEvent getNextSupersedingEvent()
                                         throws OperationFailedException

Gets the next SupersedingEvent in this list.

Returns:

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

getNextSupersedingEvents

SupersedingEvent[] getNextSupersedingEvents(long n)
                                            throws OperationFailedException

Gets the next set of SupersedingEvent elements in this list which must be less than or equal to the number returned from available().

Parameters:

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

Returns:

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