OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.CalendarList
Implementsosid.OsidList
Used Byosid.calendaring.CalendarHierarchySession
osid.calendaring.CalendarLookupSession
osid.calendaring.CalendarQuerySession
osid.calendaring.CalendarSearchResults
osid.calendaring.CommitmentCalendarSession
osid.calendaring.EventCalendarSession
osid.calendaring.OffsetEventCalendarSession
osid.calendaring.RecurringEventCalendarSession
osid.calendaring.ScheduleCalendarSession
osid.calendaring.ScheduleSlotCalendarSession
show 8 more…
osid.calendaring.SupersedingEventCalendarSession
osid.calendaring.TimePeriodCalendarSession
osid.calendaring.cycle.CyclicEventCalendarSession
osid.calendaring.cycle.CyclicTimePeriodCalendarSession
osid.calendaring.rules.CommitmentEnablerCalendarSession
osid.calendaring.rules.OffsetEventEnablerCalendarSession
osid.calendaring.rules.RecurringEventEnablerCalendarSession
osid.calendaring.rules.SupersedingEventEnablerCalendarSession
Description

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());
}
                
MethodgetNextCalendar
Description

Gets the next Calendar in this list.

Returnosid.calendaring.Calendar the next Calendar in this list. The hasNext() method should be used to test that a next Calendar is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextCalendars
Description

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

Parameterscardinaln the number of Calendar elements requested which must be less than or equal to available()
Returnosid.calendaring.Calendar[] an array of Calendar elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.