org.osid.calendaring

Interface DateTimeList

All Superinterfaces:

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

public interface DateTimeList
extends OsidList

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

       
       
       while (dtl.hasNext()) {
            DateTime time = dtl.getNextDateTime();
       }
       
                   
       
  

or

       
       
       while dtl.hasNext()) {
            DateTime[] times = dtl.getNextDateTimes(dtl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextDateTime

DateTime getNextDateTime()
                         throws OperationFailedException

Gets the next DateTime in this list.

Returns:

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

getNextDateTimes

DateTime[] getNextDateTimes(long n)
                            throws OperationFailedException

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

Parameters:

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

Returns:

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