org.osid.calendaring

Interface ScheduleList

All Superinterfaces:

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

public interface ScheduleList
extends OsidList

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

       
       
       while (sl.hasNext()) {
            Schedule schedule = sl.getNextSchedule();
       }
       
                   
       
  

or

       
       
       while (sl.hasNext()) {
            Schedule[] schedules = sl.getNextSchedules(sl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextSchedule

Schedule getNextSchedule()
                         throws OperationFailedException

Gets the next Schedule in this list.

Returns:

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

getNextSchedules

Schedule[] getNextSchedules(long n)
                            throws OperationFailedException

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

Parameters:

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

Returns:

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