Interface | osid.calendaring.CalendaringProxyManager | ||
---|---|---|---|
Implements | osid.OsidProxyManager | ||
osid.calendaring.CalendaringProfile | |||
Description |
The calendaring manager provides access to calendaring
sessions and provides interoperability tests for various
aspects of this service. Methods in this manager support the
passing of a
| ||
Method | getEventLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.EventLookupSession | an EventLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventLookup() is false | ||
Compliance | optional | This method must be implemented if supportsEventLookup() is
true. | |
Method | getEventLookupSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.EventLookupSession | an EventLookupSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsEventLookup() and
supportsVisibleFederation() are true. | |
Method | getEventQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.EventQuerySession | an EventQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventQuery() is false | ||
Compliance | optional | This method must be implemented if supportsEventQuery() is
true. | |
Method | getEventQuerySessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.EventQuerySession | an EventQuerySession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsEventQuery() and
supportsVisibleFederation() are true. | |
Method | getEventSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.EventSearchSession | an EventSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventSearch() is false | ||
Compliance | optional | This method must be implemented if supportsEventSearch() is
true. | |
Method | getEventSearchSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.EventSearchSession | an EventSearchSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsEventSearch() and
supportsVisibleFederation() are true. | |
Method | getEventAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.EventAdminSession | an EventAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsEventAdmin() is
true. | |
Method | getEventAdminSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.EventAdminSession | an EventAdminSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsEventAdmin() and
supportsVisibleFederation() are true. | |
Method | getEventNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to event changes. | ||
Parameters | osid.calendaring.EventReceiver | eventReceiver | the event receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.EventNotificationSession | an EventNotificationSession | |
Errors | NULL_ARGUMENT | eventReceiver or proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventNotification() is false | ||
Compliance | optional | This method must be implemented if supportsEventNotification()
is true. | |
Method | getEventNotificationSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.calendaring.EventReceiver | eventReceiver | the event receiver |
osid.id.Id | calendarId | the Id of the calendar | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.EventNotificationSession | an EventNotificationSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | eventReceiver, calendarId or proxy
is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsEventNotification()
and supportsVisibleFederation() are true.
| |
Method | getEventCalendarSession | ||
Description |
Gets the session for retrieving event to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.EventCalendarSession | an EventCalendarSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventCalendar() is false | ||
Compliance | optional | This method must be implemented if supportsEventCalendar()
is true. | |
Method | getEventCalendarAssignmentSession | ||
Description |
Gets the session for assigning event to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.EventCalendarAssignmentSession | an EventCalendarAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventCalendarAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsEventCalendarAssignment()
is true. | |
Method | getEventSmartCalendarSession | ||
Description |
Gets the session associated with the event smart calendar for the given calendar. | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.EventSmartCalendarSession | an EventSmartCalendarSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventSmartCalendar() is false | ||
Compliance | optional | This method must be implemented if supportsEventSmartCalendar()
is true. | |
Method | getRecurringEventLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.RecurringEventLookupSession | a RecurringEventLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecurringEventLookup() is false | ||
Compliance | optional | This method must be implemented if supportsRecurringEventLookup()
is true. | |
Method | getRecurringEventLookupSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.RecurringEventLookupSession | a RecurringEventLookupSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecurringEventLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRecurringEventLookup()
and supportsVisibleFederation() are true.
| |
Method | getRecurringEventQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.RecurringEventQuerySession | a RecurringEventQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecurringEventQuery() is false | ||
Compliance | optional | This method must be implemented if supportsRecurringEventQuery()
is true. | |
Method | getRecurringEventQuerySessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.RecurringEventQuerySession | a RecurringEventQuerySession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecurringEventQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRecurringEventQuery()
and supportsVisibleFederation() are true.
| |
Method | getRecurringEventSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.RecurringEventSearchSession | a RecurringEventSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecurringEventSearch() is false | ||
Compliance | optional | This method must be implemented if supportsRecurringEventSearch()
is true. | |
Method | getRecurringEventSearchSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.RecurringEventSearchSession | a RecurringEventSearchSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecurringEventSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRecurringEventSearch()
and supportsVisibleFederation() are true.
| |
Method | getRecurringEventAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.RecurringEventAdminSession | a RecurringEventAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecurringEventAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsRecurringEventAdmin()
is true. | |
Method | getRecurringEventAdminSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.RecurringEventAdminSession | a RecurringEventAdminSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecurringEventAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRecurringEventAdmin()
and supportsVisibleFederation() are true.
| |
Method | getRecurringEventNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to recurring event changes. | ||
Parameters | osid.calendaring.RecurringEventReceiver | recurringEventReceiver | the recurring event receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.RecurringEventNotificationSession | a RecurringEventNotificationSession | |
Errors | NULL_ARGUMENT | recurringEventReceiver or proxy is
null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecurringEventNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsRecurringEventNotification() is true. | |
Method | getRecurringEventNotificationSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.calendaring.RecurringEventReceiver | recurringEventReceiver | the recurring event receiver |
osid.id.Id | calendarId | the Id of the calendar | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.RecurringEventNotificationSession | a RecurringEventNotificationSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | recurringEventReceiver, calendarId or
proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecurringEventNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsRecurringEventNotification() and
supportsVisibleFederation() are true. | |
Method | getRecurringEventCalendarSession | ||
Description |
Gets the session for retrieving recurring event to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.RecurringEventCalendarSession | a RecurringEventCalendarSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecurringEventCalendar() is false | ||
Compliance | optional | This method must be implemented if supportsRecurringEventCalendar()
is true. | |
Method | getRecurringEventCalendarAssignmentSession | ||
Description |
Gets the session for assigning recurring event to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.RecurringEventCalendarAssignmentSession | a RecurringEventCalendarAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecurringEventCalendarAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsRecurringEventCalendarAssignment() is true. | |
Method | getRecurringEventSmartCalendarSession | ||
Description |
Gets the session associated with the recurring event smart calendar for the given calendar. | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.RecurringEventSmartCalendarSession | a RecurringEventSmartCalendarSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecurringEventSmartCalendar() is false
| ||
Compliance | optional | This method must be implemented if
supportsRecurringEventSmartCalendar() is true. | |
Method | getSupersedingEventLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.SupersedingEventLookupSession | a SupersedingEventLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventLookup() is false | ||
Compliance | optional | This method must be implemented if supportsSupersedingEventLookup()
is true. | |
Method | getSupersedingEventLookupSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.SupersedingEventLookupSession | a SupersedingEventLookupSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSupersedingEventLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSupersedingEventLookup()
and supportsVisibleFederation() are true.
| |
Method | getSupersedingEventQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.SupersedingEventQuerySession | a SupersedingEventQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSupersedingEventQuery() is false | ||
Compliance | optional | This method must be implemented if supportsSupersedingEventQuery()
is true. | |
Method | getSupersedingEventQuerySessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.SupersedingEventQuerySession | a SupersedingEventQuerySession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSupersedingEventQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSupersedingEventQuery()
and supportsVisibleFederation() are true.
| |
Method | getSupersedingEventSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.SupersedingEventSearchSession | a SupersedingEventSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventSearch() is false | ||
Compliance | optional | This method must be implemented if supportsEventSearch() is
true. | |
Method | getSupersedingEventSearchSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.SupersedingEventSearchSession | a SupersedingEventSearchSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSupersedingEventSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSupersedingEventSearch()
and supportsVisibleFederation() are true.
| |
Method | getSupersedingEventAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.SupersedingEventAdminSession | a SupersedingEventAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsSupersedingEventAdmin()
is true. | |
Method | getSupersedingEventAdminSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.SupersedingEventAdminSession | a SupersedingEventAdminSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSupersedingEventAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSupersedingEventAdmin()
and supportsVisibleFederation() are true.
| |
Method | getSupersedingEventNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to superseding event changes. | ||
Parameters | osid.calendaring.SupersedingEventReceiver | supersedingEventReceiver | the superseding event receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.SupersedingEventNotificationSession | a SupersedingEventNotificationSession | |
Errors | NULL_ARGUMENT | supersedingEventReceiver or proxy is
null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSupersedingEventNotification() is false
| ||
Compliance | optional | This method must be implemented if
supportsSupersedingEventNotification() is true. | |
Method | getSupersedingEventNotificationSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.calendaring.SupersedingEventReceiver | supersedingEventReceiver | the superseding event receiver |
osid.id.Id | calendarId | the Id of the calendar | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.SupersedingEventNotificationSession | a SupersedingEventNotificationSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | supersedingEventReceiver, calendarId or proxy
is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSupersedingEventNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsSupersedingEventNotification() and
supportsVisibleFederation() are true. | |
Method | getSupersedingEventCalendarSession | ||
Description |
Gets the session for retrieving superseding event to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.SupersedingEventCalendarSession | a SupersedingEventCalendarSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSupersedingEventCalendar() is false | ||
Compliance | optional | This method must be implemented if
supportsSupersedingEventCalendar() is true. | |
Method | getSupersedingEventCalendarAssignmentSession | ||
Description |
Gets the session for assigning superseding event to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.SupersedingEventCalendarAssignmentSession | a SupersedingEventCalendarAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSupersedingEventCalendarAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsSupersedingEventCalendarAssignment() is true. | |
Method | getSupersedingEventSmartCalendarSession | ||
Description |
Gets the session associated with the superseding event smart calendar for the given calendar. | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.SupersedingEventSmartCalendarSession | a SupersedingEventSmartCalendarSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSupersedingEventSmartCalendar() is false
| ||
Compliance | optional | This method must be implemented if
supportsSupersedingEventSmartCalendar() is true. | |
Method | getOffsetEventLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.OffsetEventLookupSession | an OffsetEventLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOffsetEventLookup() is false | ||
Compliance | optional | This method must be implemented if supportsOffsetEventLookup()
is true. | |
Method | getOffsetEventLookupSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.OffsetEventLookupSession | an OffsetEventLookupSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOffsetEventLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsOffsetEventLookup()
and supportsVisibleFederation() are true.
| |
Method | getOffsetEventQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.OffsetEventQuerySession | an OffsetEventQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOffsetEventQuery() is false | ||
Compliance | optional | This method must be implemented if supportsOffsetEventQuery()
is true. | |
Method | getOffsetEventQuerySessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.OffsetEventQuerySession | an OffsetEventQuerySession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOffsetEventQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsOffsetEventQuery()
and supportsVisibleFederation() are true.
| |
Method | getOffsetEventSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.OffsetEventSearchSession | an OffsetEventSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOffsetEventSearch() is false | ||
Compliance | optional | This method must be implemented if supportsOffsetEventSearch()
is true. | |
Method | getOffsetEventSearchSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.OffsetEventSearchSession | an OffsetEventSearchSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOffsetEventSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsOffsetEventSearch()
and supportsVisibleFederation() are true.
| |
Method | getOffsetEventAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.OffsetEventAdminSession | an OffsetEventAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOffsetEventAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsOffsetEventAdmin()
is true. | |
Method | getOffsetEventAdminSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.OffsetEventAdminSession | an OffsetEventAdminSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOffsetEventAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsOffsetEventAdmin()
and supportsVisibleFederation() are true.
| |
Method | getOffsetEventNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to offset event changes. | ||
Parameters | osid.calendaring.OffsetEventReceiver | offsetEventReceiver | the offset event receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.OffsetEventNotificationSession | an OffsetEventNotificationSession | |
Errors | NULL_ARGUMENT | offsetEventReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOffsetEventNotification() is false | ||
Compliance | optional | This method must be implemented if supportsOffsetEventNotification()
is true. | |
Method | getOffsetEventNotificationSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.calendaring.OffsetEventReceiver | offsetEventReceiver | the offset event receiver |
osid.id.Id | calendarId | the Id of the calendar | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.OffsetEventNotificationSession | an OffsetEventNotificationSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | offsetEventReceiver, calendarId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOffsetEventNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsOffsetEventNotification()
and supportsVisibleFederation() are true.
| |
Method | getOffsetEventCalendarSession | ||
Description |
Gets the session for retrieving offset event to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.OffsetEventCalendarSession | an OffsetEventCalendarSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOffsetEventCalendar() is false | ||
Compliance | optional | This method must be implemented if supportsOffsetEventCalendar()
is true. | |
Method | getOffsetEventCalendarAssignmentSession | ||
Description |
Gets the session for assigning offset event to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.OffsetEventCalendarAssignmentSession | an OffsetEventCalendarAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOffsetEventCalendarAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsOffsetEventCalendarAssignment() is true. | |
Method | getOffsetEventSmartCalendarSession | ||
Description |
Gets the session associated with the offset event smart calendar for the given calendar. | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.OffsetEventSmartCalendarSession | an OffsetEventSmartCalendarSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOffsetEventSmartCalendar() is false | ||
Compliance | optional | This method must be implemented if
supportsOffsetEventSmartCalendar() is true. | |
Method | getScheduleLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.ScheduleLookupSession | a ScheduleLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleLookup() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleLookup()
is true. | |
Method | getScheduleLookupSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.ScheduleLookupSession | a ScheduleLookupSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleLookup()
and supportsVisibleFederation() are true. | |
Method | getScheduleQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.ScheduleQuerySession | a ScheduleQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleQuery() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleQuery()
is true. | |
Method | getScheduleQuerySessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.ScheduleQuerySession | a ScheduleQuerySession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleQuery()
and supportsVisibleFederation() are true. | |
Method | getScheduleSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.ScheduleSearchSession | a ScheduleSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleSearch() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleSearch()
is true. | |
Method | getScheduleSearchSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.ScheduleSearchSession | a ScheduleSearchSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleSearch()
and supportsVisibleFederation() are true. | |
Method | getScheduleAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.ScheduleAdminSession | a ScheduleAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleAdmin()
is true. | |
Method | getScheduleAdminSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.ScheduleAdminSession | a ScheduleAdminSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleAdmin()
and supportsVisibleFederation() are true. | |
Method | getScheduleNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to schedule changes. | ||
Parameters | osid.calendaring.ScheduleReceiver | scheduleReceiver | the schedule receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.ScheduleNotificationSession | a ScheduleNotificationSession | |
Errors | NULL_ARGUMENT | scheduleReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleNotification() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleNotification()
is true. | |
Method | getScheduleNotificationSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.calendaring.ScheduleReceiver | scheduleReceiver | the schedule receiver |
osid.id.Id | calendarId | the Id of the calendar | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.ScheduleNotificationSession | a ScheduleNotificationSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | scheduleReceiver, calendarId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleNotification()
and supportsVisibleFederation() are true.
| |
Method | getScheduleCalendarSession | ||
Description |
Gets the session for retrieving schedule to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.ScheduleCalendarSession | a ScheduleCalendarSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleCalendar() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleCalendar()
is true. | |
Method | getScheduleCalendarAssignmentSession | ||
Description |
Gets the session for assigning schedule to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.ScheduleCalendarAssignmentSession | a ScheduleCalendarAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleCalendarAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsScheduleCalendarAssignment() is true. | |
Method | getScheduleSmartCalendarSession | ||
Description |
Gets the session associated with the schedule smart calendar for the given calendar. | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.ScheduleSmartCalendarSession | a ScheduleSmartCalendarSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleSmartCalendar() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleSmartCalendar()
is true. | |
Method | getScheduleSlotLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.ScheduleSlotLookupSession | a ScheduleSlotLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleSlotLookup() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleSlotLookup()
is true. | |
Method | getScheduleSlotLookupSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.ScheduleSlotLookupSession | a ScheduleSlotLookupSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleSlotLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleSlotLookup()
and supportsVisibleFederation() are true.
| |
Method | getScheduleSlotQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.ScheduleSlotQuerySession | a ScheduleSlotQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleSlotQuery() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleSlotQuery()
is true. | |
Method | getScheduleSlotQuerySessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.ScheduleSlotQuerySession | a ScheduleSlotQuerySession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleSlotQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleSlotQuery()
and supportsVisibleFederation() are true.
| |
Method | getScheduleSlotSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.ScheduleSlotSearchSession | a ScheduleSlotSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleSlotSearch() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleSlotSearch()
is true. | |
Method | getScheduleSlotSearchSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.ScheduleSlotSearchSession | a ScheduleSlotSearchSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleSlotSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleSlotSearch()
and supportsVisibleFederation() are true.
| |
Method | getScheduleSlotAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.ScheduleSlotAdminSession | a ScheduleSlotAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleSlotAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleSlotAdmin()
is true. | |
Method | getScheduleSlotAdminSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.ScheduleSlotAdminSession | a ScheduleSlotAdminSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleSlotAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleSlotAdmin()
and supportsVisibleFederation() are true.
| |
Method | getScheduleSlotNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to schedule slot changes. | ||
Parameters | osid.calendaring.ScheduleSlotReceiver | scheduleSlotReceiver | the schedule slot receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.ScheduleSlotNotificationSession | a ScheduleSlotNotificationSession | |
Errors | NULL_ARGUMENT | scheduleSlotReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleSlotNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsScheduleSlotNotification() is true. | |
Method | getScheduleSlotNotificationSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.calendaring.ScheduleSlotReceiver | scheduleSlotReceiver | the schedule slot receiver |
osid.id.Id | calendarId | the Id of the calendar | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.ScheduleSlotNotificationSession | a ScheduleSlotNotificationSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | scheduleSlotReceiver, calendarId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleSlotNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsScheduleSlotNotification() and
supportsVisibleFederation() are true. | |
Method | getScheduleSlotCalendarSession | ||
Description |
Gets the session for retrieving schedule slot to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.ScheduleSlotCalendarSession | a ScheduleSlotCalendarSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleSlotCalendar() is false | ||
Compliance | optional | This method must be implemented if supportsScheduleSlotCalendar()
is true. | |
Method | getScheduleSlotCalendarAssignmentSession | ||
Description |
Gets the session for assigning schedule slot to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.ScheduleSlotCalendarAssignmentSession | a ScheduleSlotCalendarAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleSlotCalendarAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsScheduleSlotCalendarAssignment() is true. | |
Method | getScheduleSlotSmartCalendarSession | ||
Description |
Gets the session associated with the schedule slot smart calendar for the given calendar. | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.ScheduleSlotSmartCalendarSession | a ScheduleSlotSmartCalendarSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsScheduleSlotSmartCalendar() is false | ||
Compliance | optional | This method must be implemented if
supportsScheduleSlotSmartCalendar() is true. | |
Method | getCommitmentLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.CommitmentLookupSession | a CommitmentLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCommitmentLookup() is false | ||
Compliance | optional | This method must be implemented if supportsCommitmentLookup()
is true. | |
Method | getCommitmentLookupSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.CommitmentLookupSession | a CommitmentLookupSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCommitmentLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCommitmentLookup()
and supportsVisibleFederation() are true.
| |
Method | getCommitmentQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.CommitmentQuerySession | a CommitmentQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCommitmentQuery() is false | ||
Compliance | optional | This method must be implemented if supportsCommitmentLookup()
is true. | |
Method | getCommitmentQuerySessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.CommitmentQuerySession | a CommitmentQuerySession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCommitmentQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCommitmentQuery()
and supportsVisibleFederation() are true. | |
Method | getCommitmentSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.CommitmentSearchSession | a CommitmentSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCommitmentSearch() is false | ||
Compliance | optional | This method must be implemented if supportsCommitmentSearch()
is true. | |
Method | getCommitmentSearchSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.CommitmentSearchSession | a CommitmentSearchSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCommitmentSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCommitmentSearch()
and supportsVisibleFederation() are true.
| |
Method | getCommitmentAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.CommitmentAdminSession | a CommitmentAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCommitmentAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsCommitmentAdmin()
is true. | |
Method | getCommitmentAdminSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.CommitmentAdminSession | a CommitmenttAdminSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCommitmentAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCommitmentAdmin()
and supportsVisibleFederation() are true. | |
Method | getCommitmentNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to commitment changes. | ||
Parameters | osid.calendaring.CommitmentReceiver | commitmentReceiver | the commitment receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.CommitmentNotificationSession | a CommitmentNotificationSession | |
Errors | NULL_ARGUMENT | commitmentReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCommitmentNotification() is false | ||
Compliance | optional | This method must be implemented if supportsCommitmentNotification()
is true. | |
Method | getCommitmentNotificationSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.calendaring.CommitmentReceiver | commitmentReceiver | the commitment receiver |
osid.id.Id | calendarId | the Id of the calendar | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.CommitmentNotificationSession | a CommitmentNotificationSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | commitmentReceiver, calendarId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCommitmentNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCommitmentNotification()
and supportsVisibleFederation() are true.
| |
Method | getCommitmentCalendarSession | ||
Description |
Gets the session for retrieving commitment to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.CommitmentCalendarSession | a CommitmentCalendarSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCommitmentCalendar() is false | ||
Compliance | optional | This method must be implemented if supportsCommitmentCalendar()
is true. | |
Method | getCommitmentCalendarAssignmentSession | ||
Description |
Gets the session for assigning commitment to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.CommitmentCalendarAssignmentSession | a CommitmentCalendarAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCommitmentCalendarAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsCommitmentCalendarAssignment() is true. | |
Method | getCommitmentSmartCalendarSession | ||
Description |
Gets the session associated with the commitment smart calendar for the given calendar. | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.CommitmentSmartCalendarSession | a CommitmentSmartCalendarSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCommitmentSmartCalendar() is false | ||
Compliance | optional | This method must be implemented if supportsCommitmentSmartCalendar()
is true. | |
Method | getTimePeriodLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.TimePeriodLookupSession | a TimePeriodLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTimePeriodLookup() is false | ||
Compliance | optional | This method must be implemented if supportsTimePeriodLookup()
is true. | |
Method | getTimePeriodLookupSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.TimePeriodLookupSession | a TimePeriodLookupSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTimePeriodLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTimePeriodLookup()
and supportsVisibleFederation() are true.
| |
Method | getTimePeriodQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.TimePeriodQuerySession | a TimePeriodQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTimePeriodQuery() is false | ||
Compliance | optional | This method must be implemented if supportsTimePeriodQuery()
is true. | |
Method | getTimePeriodQuerySessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.TimePeriodQuerySession | a TimePeriodQuerySession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTimePeriodQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTimePeriodQuery()
and supportsVisibleFederation() are true. | |
Method | getTimePeriodSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.TimePeriodSearchSession | a TimePeriodSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTimePeriodSearch() is false | ||
Compliance | optional | This method must be implemented if supportsTimePeriodSearch()
is true. | |
Method | getTimePeriodSearchSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.TimePeriodSearchSession | a TimePeriodSearchSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTimePeriodSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTimePeriodSearch()
and supportsVisibleFederation() are true.
| |
Method | getTimePeriodAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.TimePeriodAdminSession | a TimePeriodAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTimePeriodAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsTimePeriodAdmin()
is true. | |
Method | getTimePeriodAdminSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.TimePeriodAdminSession | calendarId not found | |
Errors | NOT_FOUND | a TimePeriodAdminSession | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTimePeriodAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTimePeriodAdmin()
and supportsVisibleFederation() are true. | |
Method | getTimePeriodNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to time period changes. | ||
Parameters | osid.calendaring.TimePeriodReceiver | timePeriodReceiver | the time period receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.TimePeriodNotificationSession | a TimePeriodNotificationSession | |
Errors | NULL_ARGUMENT | timePeriodReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTimePeriodNotification() is false | ||
Compliance | optional | This method must be implemented if supportsTimePeriodNotification()
is true. | |
Method | getTimePeriodNotificationSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.calendaring.TimePeriodReceiver | timePeriodReceiver | the time period receiver |
osid.id.Id | calendarId | the Id of the calendar | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.TimePeriodNotificationSession | a TimePeriodNotificationSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | timePeriodReceiver or calendarId or
proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTimePeriodNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTimePeriodNotification()
and supportsVisibleFederation() are true.
| |
Method | getTimePeriodCalendarSession | ||
Description |
Gets the session for retrieving time period to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.TimePeriodCalendarSession | a TimePeriodCalendarSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTimePeriodCalendar() is false | ||
Compliance | optional | This method must be implemented if supportsTimePeriodCalendar()
is true. | |
Method | getTimePeriodCalendarAssignmentSession | ||
Description |
Gets the session for assigning time period to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.TimePeriodCalendarAssignmentSession | a TimePeriodCalendarAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTimePeriodCalendarAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsTimePeriodCalendarAssignment() is true. | |
Method | getTimePeriodSmartCalendarSession | ||
Description |
Gets the session associated with the time period smart calendar for the given calendar. | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.TimePeriodSmartCalendarSession | a TimePeriodSmartCalendarSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTimePeriodSmartCalendar() is false | ||
Compliance | optional | This method must be implemented if supportsTimePeriodSmartCalendar()
is true. | |
Method | getCalendarLookupSession | ||
Description |
Gets the OsidSession associated with the calendar lookup service. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.CalendarLookupSession | a CalendarLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCalendarLookup() is false | ||
Compliance | optional | This method must be implemented if supportsCalendarLookup()
is true. | |
Method | getCalendarSearchSession | ||
Description |
Gets the OsidSession associated with the calendar search service. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.CalendarSearchSession | a CalendarSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCalendarSearch() is false | ||
Compliance | optional | This method must be implemented if supportsCalendarSearch()
is true. | |
Method | getCalendarAdminSession | ||
Description |
Gets the OsidSession associated with the calendar administration service. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.CalendarAdminSession | a CalendarAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCalendarAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsCalendarAdmin()
is true. | |
Method | getCalendarNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to calendar service changes. | ||
Parameters | osid.calendaring.CalendarReceiver | calendarReceiver | the calendar receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.CalendarNotificationSession | a CalendarNotificationSession | |
Errors | NULL_ARGUMENT | calendarReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCalendarNotification() is false | ||
Compliance | optional | This method must be implemented if supportsCalendarNotification()
is true. | |
Method | getCalendarHierarchySession | ||
Description |
Gets the session traversing calendar hierarchies. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.CalendarHierarchySession | a CalendarHierarchySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCalendarHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsCalendarHierarchy()
is true. | |
Method | getCalendarHierarchyDesignSession | ||
Description |
Gets the session designing calendar hierarchies. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.CalendarHierarchyDesignSession | a CalendarHierarchyDesignSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCalendarHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsCalendarHierarchyDesign()
is true. | |
Method | getCalandaringBatchProxyManager | ||
Description |
Gets the calendaring batch proxy manager. | ||
Return | osid.calendaring.batch.CalendaringBatchProxyManager | a CalendaringBatchProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCalendaringBatch() is false | ||
Compliance | optional | This method must be implemented if supportsCalendaringBatch()
is true. | |
Method | getCalandaringCycleProxyManager | ||
Description |
Gets the calendaring cycle proxy manager. | ||
Return | osid.calendaring.cycle.CalendaringCycleProxyManager | a CalendaringCycleProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCalendaringCycle() is false | ||
Compliance | optional | This method must be implemented if supportsCalendaringCycle()
is true. | |
Method | getCalandaringRulesProxyManager | ||
Description |
Gets the calendaring rules proxy manager. | ||
Return | osid.calendaring.rules.CalendaringRulesProxyManager | a CalendaringRulesProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCalendaringRules() is false | ||
Compliance | optional | This method must be implemented if supportsCalendaringRules()
is true. |