org.osid.calendaring

Interface TimeList

All Superinterfaces:

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

public interface TimeList
extends OsidList

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

       
       
       while (tl.hasNext()) {
            Time time = tl.getNextTime();
       }
       
                   
       
  

or

       
       
       while (tl.hasNext()) {
            Time[] times = tl.getNextTimes(tl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextTime

Time getNextTime()
                 throws OperationFailedException

Gets the next Time in this list.

Returns:

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

getNextTimes

Time[] getNextTimes(long n)
                    throws OperationFailedException

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

Parameters:

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

Returns:

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