org.osid.calendaring

Interface MeetingTimeList

All Superinterfaces:

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

public interface MeetingTimeList
extends OsidList

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

       
       
       while (mtl.hasNext()) {
            MeetingTime time = mtl.getNextMeetingTime();
       }
       
                   
       
  

or

       
       
       while (mtl.hasNext()) {
            MeetingTime[] times = mtl.getNextMeetingTimes(mtl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextMeetingTime

MeetingTime getNextMeetingTime()
                               throws OperationFailedException

Gets the next MeetingTime in this list.

Returns:

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

getNextMeetingTimes

MeetingTime[] getNextMeetingTimes(long n)
                                  throws OperationFailedException

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

Parameters:

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

Returns:

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