org.osid.calendaring

Interface EventList

All Superinterfaces:

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

public interface EventList
extends OsidList

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

       
       
       while (el.hasNext()) {
            Event event = el.getNextEvent();
       }
       
                   
       
  

or

       
       
       while (el.hasNext()) {
            Event[] events = el.getNextEvents(el.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextEvent

Event getNextEvent()
                   throws OperationFailedException

Gets the next Event in this list.

Returns:

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

getNextEvents

Event[] getNextEvents(long n)
                      throws OperationFailedException

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

Parameters:

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

Returns:

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