org.osid.calendaring

Interface CalendarList

All Superinterfaces:

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

public interface CalendarList
extends OsidList

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

       
       
       while (cl.hasNext()) {
            Calendar calendar = cl.getNextCalendar();
       }
       
                   
       
  

or

       
       
       while (cl.hasNext()) {
            Calendar[] calendars = cl.getNextCalendars(cl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Calendar	getNextCalendar() Gets the next Calendar in this list.
Calendar[]	getNextCalendars(long n) Gets the next set of Calendar elements in this list which must be less than or equal to the return 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

getNextCalendar

Calendar getNextCalendar()
                         throws OperationFailedException

Gets the next Calendar in this list.

Returns:

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

getNextCalendars

Calendar[] getNextCalendars(long n)
                            throws OperationFailedException

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

Parameters:

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

Returns:

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