OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.CalendaringManager
Implementsosid.OsidManager
osid.calendaring.CalendaringProfile
Description

The calendaring manager provides access to calendaring sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • EventLookupSession: a session to look up events
  • EventQuerySession: a session to query events
  • EventSearchSession: a session to search events
  • EventAdminSession: a session to manage events
  • EventNotificationSession: a session to receive messages pertaining to event changes
  • EventCalendarSession: a session for retriieving event and calendar mappings
  • EventCalendarAssignmentSession: a session for managing event and calendar mappings
  • EventSmartCalendarSession: a session to manage dynamic event catalogs
  • RecurringEventLookupSession: a session to look up recurring events
  • RecurringEventQuerySession: a session to query recurring events
  • RecurringEventSearchSession: a session to search recurring events
  • RecurringEventAdminSession: a session to create, modify and delete recurring event
  • RecurringEventNotificationSession: a session to receive messages pertaining to recurring event changes
  • RecurringEventCalendarSession: a session for retriieving recurring event and calendar mappings
  • RecurringEventCalendarAssignmentSession: a session for managing recurring event and calendar mappings
  • RecurringEventSmartCalendarSession: a session to manage dynamic recurring event catalogs
  • SupersedingEventLookupSession: a session to look up superseding events
  • SupersedingEventQuerySession: a session to query superseding events
  • SupersedingEventSearchSession: a session to search superseding events
  • SupersedingEventAdminSession: a session to create, modify and delete superseding events
  • SupersedingEventNotificationSession: a session to receive messages pertaining to superseding event changes
  • SupersedingEventCalendarSession: a session for retriieving superseding event and calendar mappings
  • SupersedingEventCalendarAssignmentSession: a session for managing superseding event and calendar mappings
  • SupersedingEventSmartCalendarSession: a session to manage dynamic superseding event catalogs
  • OffsetEventLookupSession: a session to look up offset events
  • OffsetEventQuerySession: a session to query offset events
  • OffsetEventSearchSession: a session to search offset events
  • OffsetEventAdminSession: a session to create, modify and delete offset events
  • OffsetEventNotificationSession: a session to receive messages pertaining to offset event changes
  • OffsetEventCalendarSession: a session for retriieving offset event and calendar mappings
  • OffsetEventCalendarAssignmentSession: a session for managing offset event and calendar mappings
  • OffsetEventSmartCalendarSession: a session to manage dynamic offset event catalogs
  • ScheduleLookupSession: a session to look up schedules
  • ScheduleQuerySession: a session to query schedules
  • ScheduleSearchSession: a session to search schedules
  • ScheduleAdminSession: a session to create, modify and delete schedules
  • ScheduleNotificationSession: a session to receive messages pertaining to schedule changes
  • ScheduleCalendarSession: a session for retriieving schedule and calendar mappings
  • ScheduleCalendarAssignmentSession: a session for managing schedule and calendar mappings
  • ScheduleSmartCalendarSession: a session to manage dynamic schedule catalogs
  • ScheduleSlotLookupSession: a session to look up schedule slots
  • ScheduleSlotQuerySession: a session to query schedule slots
  • ScheduleSlotSearchSession: a session to search scheduls slots
  • ScheduleSlotAdminSession: a session to create, modify and delete schedule slots
  • ScheduleSlotNotificationSession: a session to receive messages pertaining to schedule slot changes
  • ScheduleSlotCalendarSession: a session for retriieving schedule slot and calendar mappings
  • ScheduleSlotCalendarAssignmentSession: a session for managing schedule slot and calendar mappings
  • ScheduleSlotSmartCalendarSession: a session to manage dynamic schedule slot catalogs
  • CommitmentLookupSession: a session to look up commitments
  • CommitmentQuerySession: a session to query commitments
  • CommitmentSearchSession: a session to search commitments
  • CommitmentAdminSession: a session to create, modify and delete commitments
  • CommitmentNotificationSession: a session to receive messages pertaining to commitment changes
  • CommitmentCalendarSession: a session for retriieving commitment and calendar mappings
  • CommitmentCalendarAssignmentSession: a session for managing commitment and calendar mappings
  • CommitmentSmartCalendarSession: a session to manage dynamic commitment catalogs
  • TimePeriodLookupSession: a session to look up time periods
  • TimePeriodQuerySession: a session to query time periods
  • TimePeriodSearchSession: a session to search time periods
  • TimePeriodAdminSession: a session to create, modify and delete time periods
  • TimePeriodNotificationSession: a session to receive messages pertaining to time period changes
  • TimePeriodCalendarSession: a session for retriieving time period and calendar mappings
  • TimePeriodCalendarAssignmentSession: a session for managing time period and calendar mappings
  • TimePeriodSmartCalendarSession: a session to manage dynamic time period catalogs
  • CalendarLookupSession: a session to lookup calendars
  • CalendarSearchSession : a session to search calendars
  • CalendarAdminSession : a session to create, modify and delete calendars
  • CalendarNotificationSession : a session to receive messages pertaining to calendar changes
  • CalendarHierarchySession: a session to traverse the calendar hierarchy
  • CalendarHierarchyDesignSession: a session to manage the calendar hierarchy
MethodgetEventLookupSession
Description

Gets the OsidSession associated with the event lookup service.

Returnosid.calendaring.EventLookupSessionan EventLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventLookup() is false
ComplianceoptionalThis method must be implemented if supportsEventLookup() is true.
MethodgetEventLookupSessionForCalendar
Description

Gets the OsidSession associated with the event lookup service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.EventLookupSessionan EventLookupSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEventLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEventLookup() and supportsVisibleFederation() are true.
MethodgetEventQuerySession
Description

Gets the OsidSession associated with the event query service.

Returnosid.calendaring.EventQuerySessionan EventQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventQuery() is false
ComplianceoptionalThis method must be implemented if supportsEventQuery() is true.
MethodgetEventQuerySessionForCalendar
Description

Gets the OsidSession associated with the event query service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.EventQuerySessionan EventQuerySession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEventQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEventQuery() and supportsVisibleFederation() are true.
MethodgetEventSearchSession
Description

Gets the OsidSession associated with the event search service.

Returnosid.calendaring.EventSearchSessionan EventSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventSearch() is false
ComplianceoptionalThis method must be implemented if supportsEventSearch() is true.
MethodgetEventSearchSessionForCalendar
Description

Gets the OsidSession associated with the event search service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.EventSearchSessionan EventSearchSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEventSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEventSearch() and supportsVisibleFederation() are true.
MethodgetEventAdminSession
Description

Gets the OsidSession associated with the event administration service.

Returnosid.calendaring.EventAdminSessionan EventAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventAdmin() is false
ComplianceoptionalThis method must be implemented if supportsEventAdmin() is true.
MethodgetEventAdminSessionForCalendar
Description

Gets the OsidSession associated with the event admin service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.EventAdminSessionan EventAdminSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEventAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEventAdmin() and supportsVisibleFederation() are true.
MethodgetEventNotificationSession
Description

Gets the notification session for notifications pertaining to event changes.

Parametersosid.calendaring.EventReceivereventReceiverthe event receiver
Returnosid.calendaring.EventNotificationSessionan EventNotificationSession
ErrorsNULL_ARGUMENT eventReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventNotification() is false
ComplianceoptionalThis method must be implemented if supportsEventNotification() is true.
MethodgetEventNotificationSessionForCalendar
Description

Gets the OsidSession associated with the event notification service for the given calendar.

Parametersosid.calendaring.EventReceivereventReceiverthe event receiver
osid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.EventNotificationSessionan EventNotificationSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT eventReceiver or calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEventNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEventNotification() and supportsVisibleFederation() are true.
MethodgetEventCalendarSession
Description

Gets the session for retrieving event to calendar mappings.

Returnosid.calendaring.EventCalendarSessionan EventCalendarSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventCalendar() is false
ComplianceoptionalThis method must be implemented if supportsEventCalendar() is true.
MethodgetEventCalendarAssignmentSession
Description

Gets the session for assigning event to calendar mappings.

Returnosid.calendaring.EventCalendarAssignmentSessionan EventCalendarAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventCalendarAssignment() is false
ComplianceoptionalThis method must be implemented if supportsEventCalendarAssignment() is true.
MethodgetEventSmartCalendarSession
Description

Gets the session associated with the event smart calendar for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.EventSmartCalendarSessionan EventSmartCalendarSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventSmartCalendar() is false
ComplianceoptionalThis method must be implemented if supportsEventSmartCalendar() is true.
MethodgetRecurringEventLookupSession
Description

Gets the OsidSession associated with the recurring event lookup service.

Returnosid.calendaring.RecurringEventLookupSessiona RecurringEventLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecurringEventLookup() is false
ComplianceoptionalThis method must be implemented if supportsRecurringEventLookup() is true.
MethodgetRecurringEventLookupSessionForCalendar
Description

Gets the OsidSession associated with the recurring event lookup service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.RecurringEventLookupSessiona RecurringEventLookupSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecurringEventLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRecurringEventLookup() and supportsVisibleFederation() are true.
MethodgetRecurringEventQuerySession
Description

Gets the OsidSession associated with the recurring event query service.

Returnosid.calendaring.RecurringEventQuerySessiona RecurringEventQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecurringEventQuery() is false
ComplianceoptionalThis method must be implemented if supportsRecurringEventQuery() is true.
MethodgetRecurringEventQuerySessionForCalendar
Description

Gets the OsidSession associated with the recurring event query service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.RecurringEventQuerySessiona RecurringEventQuerySession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecurringEventQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRecurringEventQuery() and supportsVisibleFederation() are true.
MethodgetRecurringEventSearchSession
Description

Gets the OsidSession associated with the recurring event search service.

Returnosid.calendaring.RecurringEventSearchSessiona RecurringEventSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecurringEventSearch() is false
ComplianceoptionalThis method must be implemented if supportsRecurringEventSearch() is true.
MethodgetRecurringEventSearchSessionForCalendar
Description

Gets the OsidSession associated with the recurring event search service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.RecurringEventSearchSessiona RecurringEventSearchSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecurringEventSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRecurringEventSearch() and supportsVisibleFederation() are true.
MethodgetRecurringEventAdminSession
Description

Gets the OsidSession associated with the recurring event administration service.

Returnosid.calendaring.RecurringEventAdminSessiona RecurringEventAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecurringEventAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRecurringEventAdmin() is true.
MethodgetRecurringEventAdminSessionForCalendar
Description

Gets the OsidSession associated with the recurring event admin service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.RecurringEventAdminSessiona RecurringEventAdminSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecurringEventAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRecurringEventAdmin() and supportsVisibleFederation() are true.
MethodgetRecurringEventNotificationSession
Description

Gets the notification session for notifications pertaining to recurring event changes.

Parametersosid.calendaring.RecurringEventReceiverrecurringEventReceiverthe recurring event receiver
Returnosid.calendaring.RecurringEventNotificationSessiona RecurringEventNotificationSession
ErrorsNULL_ARGUMENT recurringEventReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecurringEventNotification() is false
ComplianceoptionalThis method must be implemented if supportsRecurringEventNotification() is true.
MethodgetRecurringEventNotificationSessionForCalendar
Description

Gets the OsidSession associated with the recurring event notification service for the given calendar.

Parametersosid.calendaring.RecurringEventReceiverrecurringEventReceiverthe recurring event receiver
osid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.RecurringEventNotificationSessiona RecurringEventNotificationSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT recurringEventReceiver or calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecurringEventNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRecurringEventNotification() and supportsVisibleFederation() are true.
MethodgetRecurringEventCalendarSession
Description

Gets the session for retrieving recurring event to calendar mappings.

Returnosid.calendaring.RecurringEventCalendarSessionA RecurringEventCalendarSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecurringEventCalendar() is false
ComplianceoptionalThis method must be implemented if supportsRecurringEventCalendar() is true.
MethodgetRecurringEventCalendarAssignmentSession
Description

Gets the session for assigning recurring event to calendar mappings.

Returnosid.calendaring.RecurringEventCalendarAssignmentSessiona RecurringEventCalendarAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecurringEventCalendarAssignment() is false
ComplianceoptionalThis method must be implemented if supportsRecurringEventCalendarAssignment() is true.
MethodgetRecurringEventSmartCalendarSession
Description

Gets the session associated with the recurring event smart calendar for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.RecurringEventSmartCalendarSessiona RecurringEventSmartCalendarSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecurringEventSmartCalendar() is false
ComplianceoptionalThis method must be implemented if supportsRecurringEventSmartCalendar() is true.
MethodgetSupersedingEventLookupSession
Description

Gets the OsidSession associated with the superseding event lookup service.

Returnosid.calendaring.SupersedingEventLookupSessiona SupersedingEventLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventLookup() is false
ComplianceoptionalThis method must be implemented if supportsSupersedingEventLookup() is true.
MethodgetSupersedingEventLookupSessionForCalendar
Description

Gets the OsidSession associated with the superseding event lookup service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.SupersedingEventLookupSessiona SupersedingEventLookupSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSupersedingEventLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSupersedingEventLookup() and supportsVisibleFederation() are true.
MethodgetSupersedingEventQuerySession
Description

Gets the OsidSession associated with the superseding event query service.

Returnosid.calendaring.SupersedingEventQuerySessiona SupersedingEventQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSupersedingEventQuery() is false
ComplianceoptionalThis method must be implemented if supportsSupersedingEventQuery() is true.
MethodgetSupersedingEventQuerySessionForCalendar
Description

Gets the OsidSession associated with the superseding event query service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.SupersedingEventQuerySessiona SupersedingEventQuerySession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSupersedingEventQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSupersedingEventQuery() and supportsVisibleFederation() are true.
MethodgetSupersedingEventSearchSession
Description

Gets the OsidSession associated with the superseding event search service.

Returnosid.calendaring.SupersedingEventSearchSessiona SupersedingEventSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventSearch() is false
ComplianceoptionalThis method must be implemented if supportsEventSearch() is true.
MethodgetSupersedingEventSearchSessionForCalendar
Description

Gets the OsidSession associated with the superseding event search service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.SupersedingEventSearchSessiona SupersedingEventSearchSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSupersedingEventSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSupersedingEventSearch() and supportsVisibleFederation() are true.
MethodgetSupersedingEventAdminSession
Description

Gets the OsidSession associated with the superseding event administration service.

Returnosid.calendaring.SupersedingEventAdminSessiona SupersedingEventAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventAdmin() is false
ComplianceoptionalThis method must be implemented if supportsSupersedingEventAdmin() is true.
MethodgetSupersedingEventAdminSessionForCalendar
Description

Gets the OsidSession associated with the superseding event admin service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.SupersedingEventAdminSessiona SupersedingEventAdminSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSupersedingEventAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSupersedingEventAdmin() and supportsVisibleFederation() are true.
MethodgetSupersedingEventNotificationSession
Description

Gets the notification session for notifications pertaining to superseding event changes.

Parametersosid.calendaring.SupersedingEventReceiversupersedingEventReceiverthe superseding event receiver
Returnosid.calendaring.SupersedingEventNotificationSessiona SupersedingEventNotificationSession
ErrorsNULL_ARGUMENT supersedingEventReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSupersedingEventNotification() is false
ComplianceoptionalThis method must be implemented if supportsSupersedingEventNotification() is true.
MethodgetSupersedingEventNotificationSessionForCalendar
Description

Gets the OsidSession associated with the superseding event notification service for the given calendar.

Parametersosid.calendaring.SupersedingEventReceiversupersedingEventReceiverthe superseding event receiver
osid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.SupersedingEventNotificationSessiona SupersedingEventNotificationSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT supersedingEventReceiver or calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSupersedingEventNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSupersedingEventNotification() and supportsVisibleFederation() are true.
MethodgetSupersedingEventCalendarSession
Description

Gets the session for retrieving superseding event to calendar mappings.

Returnosid.calendaring.SupersedingEventCalendarSessiona SupersedingEventCalendarSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSupersedingEventCalendar() is false
ComplianceoptionalThis method must be implemented if supportsSupersedingEventCalendar() is true.
MethodgetSupersedingEventCalendarAssignmentSession
Description

Gets the session for assigning superseding event to calendar mappings.

Returnosid.calendaring.SupersedingEventCalendarAssignmentSessiona SupersedingEventCalendarAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSupersedingEventCalendarAssignment() is false
ComplianceoptionalThis method must be implemented if supportsSupersedingEventCalendarAssignment() is true.
MethodgetSupersedingEventSmartCalendarSession
Description

Gets the session associated with the superseding event smart calendar for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.SupersedingEventSmartCalendarSessiona SupersedingEventSmartCalendarSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSupersedingEventSmartCalendar() is false
ComplianceoptionalThis method must be implemented if supportsSupersedingEventSmartCalendar() is true.
MethodgetOffsetEventLookupSession
Description

Gets the OsidSession associated with the offset event lookup service.

Returnosid.calendaring.OffsetEventLookupSessionan OffsetEventLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOffsetEventLookup() is false
ComplianceoptionalThis method must be implemented if supportsOffsetEventLookup() is true.
MethodgetOffsetEventLookupSessionForCalendar
Description

Gets the OsidSession associated with the offset event lookup service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.OffsetEventLookupSessionan OffsetEventLookupSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOffsetEventLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsOffsetEventLookup() and supportsVisibleFederation() are true.
MethodgetOffsetEventQuerySession
Description

Gets the OsidSession associated with the offset event query service.

Returnosid.calendaring.OffsetEventQuerySessionan OffsetEventQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOffsetEventQuery() is false
ComplianceoptionalThis method must be implemented if supportsOffsetEventQuery() is true.
MethodgetOffsetEventQuerySessionForCalendar
Description

Gets the OsidSession associated with the offset event query service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.OffsetEventQuerySessionan OffsetEventQuerySession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOffsetEventQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsOffsetEventQuery() and supportsVisibleFederation() are true.
MethodgetOffsetEventSearchSession
Description

Gets the OsidSession associated with the offset event search service.

Returnosid.calendaring.OffsetEventSearchSessionan OffsetEventSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOffsetEventSearch() is false
ComplianceoptionalThis method must be implemented if supportsOffsetEventSearch() is true.
MethodgetOffsetEventSearchSessionForCalendar
Description

Gets the OsidSession associated with the offset event search service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.OffsetEventSearchSessionan OffsetEventSearchSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOffsetEventSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsOffsetEventSearch() and supportsVisibleFederation() are true.
MethodgetOffsetEventAdminSession
Description

Gets the OsidSession associated with the offset event administration service.

Returnosid.calendaring.OffsetEventAdminSessionan OffsetEventAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOffsetEventAdmin() is false
ComplianceoptionalThis method must be implemented if supportsOffsetEventAdmin() is true.
MethodgetOffsetEventAdminSessionForCalendar
Description

Gets the OsidSession associated with the offset event admin service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.OffsetEventAdminSessionan OffsetEventAdminSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOffsetEventAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsOffsetEventAdmin() and supportsVisibleFederation() are true.
MethodgetOffsetEventNotificationSession
Description

Gets the notification session for notifications pertaining to offset event changes.

Parametersosid.calendaring.OffsetEventReceiveroffsetEventReceiverthe offset event receiver
Returnosid.calendaring.OffsetEventNotificationSessionan OffsetEventNotificationSession
ErrorsNULL_ARGUMENT offsetEventReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOffsetEventNotification() is false
ComplianceoptionalThis method must be implemented if supportsOffsetEventNotification() is true.
MethodgetOffsetEventNotificationSessionForCalendar
Description

Gets the OsidSession associated with the offset event notification service for the given calendar.

Parametersosid.calendaring.OffsetEventReceiveroffsetEventReceiverthe offset event receiver
osid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.OffsetEventNotificationSessionan OffsetEventNotificationSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT offsetEventReceiver or calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOffsetEventNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsOffsetEventNotification() and supportsVisibleFederation() are true.
MethodgetOffsetEventCalendarSession
Description

Gets the session for retrieving offset event to calendar mappings.

Returnosid.calendaring.OffsetEventCalendarSessionan OffsetEventCalendarSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOffsetEventCalendar() is false
ComplianceoptionalThis method must be implemented if supportsOffsetEventCalendar() is true.
MethodgetOffsetEventCalendarAssignmentSession
Description

Gets the session for assigning offset event to calendar mappings.

Returnosid.calendaring.OffsetEventCalendarAssignmentSessionan OffsetEventCalendarAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOffsetEventCalendarAssignment() is false
ComplianceoptionalThis method must be implemented if supportsOffsetEventCalendarAssignment() is true.
MethodgetOffsetEventSmartCalendarSession
Description

Gets the session associated with the offset event smart calendar for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.OffsetEventSmartCalendarSessionan OffsetEventSmartCalendarSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOffsetEventSmartCalendar() is false
ComplianceoptionalThis method must be implemented if supportsOffsetEventSmartCalendar() is true.
MethodgetScheduleLookupSession
Description

Gets the OsidSession associated with the schedule lookup service.

Returnosid.calendaring.ScheduleLookupSessiona ScheduleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsScheduleLookup() is false
ComplianceoptionalThis method must be implemented if supportsScheduleLookup() is true.
MethodgetScheduleLookupSessionForCalendar
Description

Gets the OsidSession associated with the schedule lookup service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.ScheduleLookupSessiona ScheduleLookupSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsScheduleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsScheduleLookup() and supportsVisibleFederation() are true.
MethodgetScheduleQuerySession
Description

Gets the OsidSession associated with the schedule query service.

Returnosid.calendaring.ScheduleQuerySessiona ScheduleQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsScheduleQuery() is false
ComplianceoptionalThis method must be implemented if supportsScheduleQuery() is true.
MethodgetScheduleQuerySessionForCalendar
Description

Gets the OsidSession associated with the schedule query service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.ScheduleQuerySessiona ScheduleQuerySession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsScheduleQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsScheduleQuery() and supportsVisibleFederation() are true.
MethodgetScheduleSearchSession
Description

Gets the OsidSession associated with the schedule search service.

Returnosid.calendaring.ScheduleSearchSessiona ScheduleSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsScheduleSearch() is false
ComplianceoptionalThis method must be implemented if supportsScheduleSearch() is true.
MethodgetScheduleSearchSessionForCalendar
Description

Gets the OsidSession associated with the schedule search service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.ScheduleSearchSessiona ScheduleSearchSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsScheduleSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsScheduleSearch() and supportsVisibleFederation() are true.
MethodgetScheduleAdminSession
Description

Gets the OsidSession associated with the schedule administration service.

Returnosid.calendaring.ScheduleAdminSessiona ScheduleAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsScheduleAdmin() is false
ComplianceoptionalThis method must be implemented if supportsScheduleAdmin() is true.
MethodgetScheduleAdminSessionForCalendar
Description

Gets the OsidSession associated with the schedule admin service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.ScheduleAdminSessiona ScheduleAdminSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsScheduleAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsScheduleAdmin() and supportsVisibleFederation() are true.
MethodgetScheduleNotificationSession
Description

Gets the notification session for notifications pertaining to schedule changes.

Parametersosid.calendaring.ScheduleReceiverscheduleReceiverthe schedule receiver
Returnosid.calendaring.ScheduleNotificationSessiona ScheduleNotificationSession
ErrorsNULL_ARGUMENT scheduleReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsScheduleNotification() is false
ComplianceoptionalThis method must be implemented if supportsScheduleNotification() is true.
MethodgetScheduleNotificationSessionForCalendar
Description

Gets the OsidSession associated with the schedule notification service for the given calendar.

Parametersosid.calendaring.ScheduleReceiverscheduleReceiverthe schedule receiver
osid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.ScheduleNotificationSessiona ScheduleNotificationSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT scheduleReceiver or calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsScheduleNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsScheduleNotification() and supportsVisibleFederation() are true.
MethodgetScheduleCalendarSession
Description

Gets the session for retrieving schedule to calendar mappings.

Returnosid.calendaring.ScheduleCalendarSessiona ScheduleCalendarSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsScheduleCalendar() is false
ComplianceoptionalThis method must be implemented if supportsScheduleCalendar() is true.
MethodgetScheduleCalendarAssignmentSession
Description

Gets the session for assigning schedule to calendar mappings.

Returnosid.calendaring.ScheduleCalendarAssignmentSessiona ScheduleCalendarAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsScheduleCalendarAssignment() is false
ComplianceoptionalThis method must be implemented if supportsScheduleCalendarAssignment() is true.
MethodgetScheduleSmartCalendarSession
Description

Gets the session associated with the schedule smart calendar for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.ScheduleSmartCalendarSessiona ScheduleSmartCalendarSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsScheduleSmartCalendar() is false
ComplianceoptionalThis method must be implemented if supportsScheduleSmartCalendar() is true.
MethodgetScheduleSlotLookupSession
Description

Gets the OsidSession associated with the schedule slot lookup service.

Returnosid.calendaring.ScheduleSlotLookupSessiona ScheduleSlotLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsScheduleSlotLookup() is false
ComplianceoptionalThis method must be implemented if supportsScheduleSlotLookup() is true.
MethodgetScheduleSlotLookupSessionForCalendar
Description

Gets the OsidSession associated with the schedule slot lookup service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.ScheduleSlotLookupSessiona ScheduleSlotLookupSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsScheduleSlotLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsScheduleSlotLookup() and supportsVisibleFederation() are true.
MethodgetScheduleSlotQuerySession
Description

Gets the OsidSession associated with the schedule slot query service.

Returnosid.calendaring.ScheduleSlotQuerySessiona ScheduleSlotQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsScheduleSlotQuery() is false
ComplianceoptionalThis method must be implemented if supportsScheduleSlotQuery() is true.
MethodgetScheduleSlotQuerySessionForCalendar
Description

Gets the OsidSession associated with the schedule slot query service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.ScheduleSlotQuerySessiona ScheduleSlotQuerySession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsScheduleSlotQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsScheduleSlotQuery() and supportsVisibleFederation() are true.
MethodgetScheduleSlotSearchSession
Description

Gets the OsidSession associated with the schedule slot search service.

Returnosid.calendaring.ScheduleSlotSearchSessiona ScheduleSlotSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsScheduleSlotSearch() is false
ComplianceoptionalThis method must be implemented if supportsScheduleSlotSearch() is true.
MethodgetScheduleSlotSearchSessionForCalendar
Description

Gets the OsidSession associated with the schedule slot search service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.ScheduleSlotSearchSessiona ScheduleSlotSearchSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsScheduleSlotSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsScheduleSlotSearch() and supportsVisibleFederation() are true.
MethodgetScheduleSlotAdminSession
Description

Gets the OsidSession associated with the schedule slot administration service.

Returnosid.calendaring.ScheduleSlotAdminSessiona ScheduleSlotAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsScheduleSlotAdmin() is false
ComplianceoptionalThis method must be implemented if supportsScheduleSlotAdmin() is true.
MethodgetScheduleSlotAdminSessionForCalendar
Description

Gets the OsidSession associated with the schedule slot admin service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.ScheduleSlotAdminSessiona ScheduleSlotAdminSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsScheduleSlotAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsScheduleSlotAdmin() and supportsVisibleFederation() are true.
MethodgetScheduleSlotNotificationSession
Description

Gets the notification session for notifications pertaining to schedule slot changes.

Parametersosid.calendaring.ScheduleSlotReceiverscheduleSlotReceiverthe schedule slot receiver
Returnosid.calendaring.ScheduleSlotNotificationSessiona ScheduleSlotNotificationSession
ErrorsNULL_ARGUMENT scheduleSlotReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsScheduleSlotNotification() is false
ComplianceoptionalThis method must be implemented if supportsScheduleSlotNotification() is true.
MethodgetScheduleSlotNotificationSessionForCalendar
Description

Gets the OsidSession associated with the schedule slot notification service for the given calendar.

Parametersosid.calendaring.ScheduleSlotReceiverscheduleSlotReceiverthe schedule slot receiver
osid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.ScheduleSlotNotificationSessiona ScheduleSlotNotificationSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT scheduleSlotReceiver or calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsScheduleSlotNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsScheduleSlotNotification() and supportsVisibleFederation() are true.
MethodgetScheduleSlotCalendarSession
Description

Gets the session for retrieving schedule slot to calendar mappings.

Returnosid.calendaring.ScheduleSlotCalendarSessiona ScheduleSlotCalendarSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsScheduleSlotCalendar() is false
ComplianceoptionalThis method must be implemented if supportsScheduleSlotCalendar() is true.
MethodgetScheduleSlotCalendarAssignmentSession
Description

Gets the session for assigning schedule slot to calendar mappings.

Returnosid.calendaring.ScheduleSlotCalendarAssignmentSessiona ScheduleSlotCalendarAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsScheduleSlotCalendarAssignment() is false
ComplianceoptionalThis method must be implemented if supportsScheduleSlotCalendarAssignment() is true.
MethodgetScheduleSlotSmartCalendarSession
Description

Gets the session associated with the schedule slot smart calendar for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.ScheduleSlotSmartCalendarSessiona ScheduleSlotSmartCalendarSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsScheduleSlotSmartCalendar() is false
ComplianceoptionalThis method must be implemented if supportsScheduleSlotSmartCalendar() is true.
MethodgetCommitmentLookupSession
Description

Gets the OsidSession associated with the commitment lookup service.

Returnosid.calendaring.CommitmentLookupSessiona CommitmentLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCommitmentLookup() is false
ComplianceoptionalThis method must be implemented if supportsCommitmentLookup() is true.
MethodgetCommitmentLookupSessionForCalendar
Description

Gets the OsidSession associated with the commitment lookup service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.CommitmentLookupSessiona CommitmentLookupSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCommitmentLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCommitmentLookup() and supportsVisibleFederation() are true.
MethodgetCommitmentQuerySession
Description

Gets the OsidSession associated with the commitment query service.

Returnosid.calendaring.CommitmentQuerySessiona CommitmentQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCommitmentQuery() is false
ComplianceoptionalThis method must be implemented if supportsCommitmentLookup() is true.
MethodgetCommitmentQuerySessionForCalendar
Description

Gets the OsidSession associated with the commitment query service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.CommitmentQuerySessiona CommitmentQuerySession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCommitmentQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCommitmentQuery() and supportsVisibleFederation() are true.
MethodgetCommitmentSearchSession
Description

Gets the OsidSession associated with the commitment search service.

Returnosid.calendaring.CommitmentSearchSessiona CommitmentSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCommitmentSearch() is false
ComplianceoptionalThis method must be implemented if supportsCommitmentSearch() is true.
MethodgetCommitmentSearchSessionForCalendar
Description

Gets the OsidSession associated with the commitment search service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.CommitmentSearchSessiona CommitmentSearchSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCommitmentSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCommitmentSearch() and supportsVisibleFederation() are true.
MethodgetCommitmentAdminSession
Description

Gets the OsidSession associated with the commitment administration service.

Returnosid.calendaring.CommitmentAdminSessiona CommitmentAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCommitmentAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCommitmentAdmin() is true.
MethodgetCommitmentAdminSessionForCalendar
Description

Gets the OsidSession associated with the commitment admin service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.CommitmentAdminSessiona CommitmenttAdminSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCommitmentAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCommitmentAdmin() and supportsVisibleFederation() are true.
MethodgetCommitmentNotificationSession
Description

Gets the notification session for notifications pertaining to commitment changes.

Parametersosid.calendaring.CommitmentReceivercommitmentReceiverthe commitment receiver
Returnosid.calendaring.CommitmentNotificationSessiona CommitmentNotificationSession
ErrorsNULL_ARGUMENT commitmentReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCommitmentNotification() is false
ComplianceoptionalThis method must be implemented if supportsCommitmentNotification() is true.
MethodgetCommitmentNotificationSessionForCalendar
Description

Gets the OsidSession associated with the commitment notification service for the given calendar.

Parametersosid.calendaring.CommitmentReceivercommitmentReceiverthe commitment receiver
osid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.CommitmentNotificationSessiona CommitmentNotificationSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT commitmentReceiver or calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCommitmentNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCommitmentNotification() and supportsVisibleFederation() are true.
MethodgetCommitmentCalendarSession
Description

Gets the session for retrieving commitment to calendar mappings.

Returnosid.calendaring.CommitmentCalendarSessiona CommitmentCalendarSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCommitmentCalendar() is false
ComplianceoptionalThis method must be implemented if supportsCommitmentCalendar() is true.
MethodgetCommitmentCalendarAssignmentSession
Description

Gets the session for assigning commitment to calendar mappings.

Returnosid.calendaring.CommitmentCalendarAssignmentSessiona CommitmentCalendarAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCommitmentCalendarAssignment() is false
ComplianceoptionalThis method must be implemented if supportsCommitmentCalendarAssignment() is true.
MethodgetCommitmentSmartCalendarSession
Description

Gets the session associated with the commitment smart calendar for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.CommitmentSmartCalendarSessiona CommitmentSmartCalendarSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCommitmentSmartCalendar() is false
ComplianceoptionalThis method must be implemented if supportsCommitmentSmartCalendar() is true.
MethodgetTimePeriodLookupSession
Description

Gets the OsidSession associated with the time period lookup service.

Returnosid.calendaring.TimePeriodLookupSessiona TimePeriodLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTimePeriodLookup() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodLookup() is true.
MethodgetTimePeriodLookupSessionForCalendar
Description

Gets the OsidSession associated with the time period lookup service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.TimePeriodLookupSessiona TimePeriodLookupSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTimePeriodLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodLookup() and supportsVisibleFederation() are true.
MethodgetTimePeriodQuerySession
Description

Gets the OsidSession associated with the time period query service.

Returnosid.calendaring.TimePeriodQuerySessiona TimePeriodQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTimePeriodQuery() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodQuery() is true.
MethodgetTimePeriodQuerySessionForCalendar
Description

Gets the OsidSession associated with the time period query service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.TimePeriodQuerySessiona TimePeriodQuerySession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTimePeriodQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodQuery() and supportsVisibleFederation() are true.
MethodgetTimePeriodSearchSession
Description

Gets the OsidSession associated with the time period search service.

Returnosid.calendaring.TimePeriodSearchSessiona TimePeriodSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTimePeriodSearch() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodSearch() is true.
MethodgetTimePeriodSearchSessionForCalendar
Description

Gets the OsidSession associated with the time period search service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.TimePeriodSearchSessiona TimePeriodSearchSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTimePeriodSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodSearch() and supportsVisibleFederation() are true.
MethodgetTimePeriodAdminSession
Description

Gets the OsidSession associated with the time period administration service.

Returnosid.calendaring.TimePeriodAdminSessiona TimePeriodAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTimePeriodAdmin() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodAdmin() is true.
MethodgetTimePeriodAdminSessionForCalendar
Description

Gets the OsidSession associated with the time period admin service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.TimePeriodAdminSessiona TimePeriodAdminSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTimePeriodAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodAdmin() and supportsVisibleFederation() are true.
MethodgetTimePeriodNotificationSession
Description

Gets the notification session for notifications pertaining to time period changes.

Parametersosid.calendaring.TimePeriodReceivertimePeriodReceiverthe time period receiver
Returnosid.calendaring.TimePeriodNotificationSessiona TimePeriodNotificationSession
ErrorsNULL_ARGUMENT timePeriodReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTimePeriodNotification() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodNotification() is true.
MethodgetTimePeriodNotificationSessionForCalendar
Description

Gets the OsidSession associated with the time period notification service for the given calendar.

Parametersosid.calendaring.TimePeriodReceivertimePeriodReceiverthe time period receiver
osid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.TimePeriodNotificationSession a TimePeriodNotificationSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT timePeriodReceiver or calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTimePeriodNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodNotification() and supportsVisibleFederation() are true.
MethodgetTimePeriodCalendarSession
Description

Gets the session for retrieving time period to calendar mappings.

Returnosid.calendaring.TimePeriodCalendarSessiona TimePeriodCalendarSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTimePeriodCalendar() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodCalendar() is true.
MethodgetTimePeriodCalendarAssignmentSession
Description

Gets the session for assigning time period to calendar mappings.

Returnosid.calendaring.TimePeriodCalendarAssignmentSessiona TimePeriodCalendarAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTimePeriodCalendarAssignment() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodCalendarAssignment() is true.
MethodgetTimePeriodSmartCalendarSession
Description

Gets the session associated with the time period smart calendar for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.TimePeriodSmartCalendarSessiona TimePeriodSmartCalendarSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTimePeriodSmartCalendar() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodSmartCalendar() is true.
MethodgetCalendarLookupSession
Description

Gets the OsidSession associated with the calendar lookup service.

Returnosid.calendaring.CalendarLookupSessiona CalendarLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCalendarLookup() is false
ComplianceoptionalThis method must be implemented if supportsCalendarLookup() is true.
MethodgetCalendarSearchSession
Description

Gets the OsidSession associated with the calendar search service.

Returnosid.calendaring.CalendarSearchSessiona CalendarSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCalendarSearch() is false
ComplianceoptionalThis method must be implemented if supportsCalendarSearch() is true.
MethodgetCalendarAdminSession
Description

Gets the OsidSession associated with the calendar administration service.

Returnosid.calendaring.CalendarAdminSessiona CalendarAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCalendarAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCalendarAdmin() is true.
MethodgetCalendarNotificationSession
Description

Gets the notification session for notifications pertaining to calendar service changes.

Parametersosid.calendaring.CalendarReceivercalendarReceiverthe calendar receiver
Returnosid.calendaring.CalendarNotificationSessiona CalendarNotificationSession
ErrorsNULL_ARGUMENT calendarReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCalendarNotification() is false
ComplianceoptionalThis method must be implemented if supportsCalendarNotification() is true.
MethodgetCalendarHierarchySession
Description

Gets the session traversing calendar hierarchies.

Returnosid.calendaring.CalendarHierarchySessiona CalendarHierarchySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCalendarHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsCalendarHierarchy() is true.
MethodgetCalendarHierarchyDesignSession
Description

Gets the session designing calendar hierarchies.

Returnosid.calendaring.CalendarHierarchyDesignSessiona CalendarHierarchyDesignSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCalendarHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsCalendarHierarchyDesign() is true.
MethodgetCalandaringBatchManager
Description

Gets the calendaring batch manager.

Returnosid.calendaring.batch.CalendaringBatchManagera CalendaringBatchManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCalendaringBatch() is false
ComplianceoptionalThis method must be implemented if supportsCalendaringBatch() is true.
MethodgetCalandaringCycleManager
Description

Gets the calendaring cycle manager.

Returnosid.calendaring.cycle.CalendaringCycleManagera CalendaringCycleManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCalendaringCycle() is false
ComplianceoptionalThis method must be implemented if supportsCalendaringCycle() is true.
MethodgetCalandaringRulesManager
Description

Gets the calendaring rules manager.

Returnosid.calendaring.rules.CalendaringRulesManagera CalendaringRulesManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCalendaringRules() is false
ComplianceoptionalThis method must be implemented if supportsCalendaringRules() is true.