Interface | osid.calendaring.cycle.CalendaringCycleProxyManager | ||
---|---|---|---|
Implements | osid.OsidProxyManager | ||
osid.calendaring.cycle.CalendaringCycleProfile | |||
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 | getCyclicEventLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.cycle.CyclicEventLookupSession | 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 | getCyclicEventLookupSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.cycle.CyclicEventLookupSession | CyclicEventLookupSession | |
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 | getCyclicEventQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.cycle.CyclicEventQuerySession | 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 | getCyclicEventQuerySessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.cycle.CyclicEventQuerySession | CyclicEventQuerySession | |
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 | getCyclicEventSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.cycle.CyclicEventSearchSession | 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 | getCyclicEventSearchSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.cycle.CyclicEventSearchSession | CyclicEventSearchSession | |
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 | getCyclicEventAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.cycle.CyclicEventAdminSession | 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 | getCyclicEventAdminSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.cycle.CyclicEventAdminSession | CyclicEventAdminSession | |
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 | getCyclicEventNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to event changes. | ||
Parameters | osid.calendaring.cycle.CyclicEventReceiver | eventReceiver | the cyclic event receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.cycle.CyclicEventNotificationSession | 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 | getCyclicEventNotificationSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.calendaring.cycle.CyclicEventReceiver | eventReceiver | the cyclic event receiver |
osid.id.Id | calendarId | the Id of the calendar | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.cycle.CyclicEventNotificationSession | CyclicEventNotificationSession | |
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 | getCyclicEventCalendarSession | ||
Description |
Gets the session for retrieving event to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.cycle.CyclicEventCalendarSession | 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 | getCyclicEventCalendarAssignmentSession | ||
Description |
Gets the session for assigning event to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.cycle.CyclicEventCalendarAssignmentSession | 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 | getCyclicEventSmartCalendarSession | ||
Description |
Gets the session associated with the cyclic 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.cycle.CyclicEventSmartCalendarSession | 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 | getEventCyclicEventLookupSession | ||
Description |
Gets the session for retrieving event to cyclic event associations. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.cycle.EventCyclicEventLookupSession | an EventCyclicEventLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventCyclicEventLookup() is false | ||
Compliance | optional | This method must be implemented if supportsEventCyclicEventLookup()
is true. | |
Method | getEventCyclicEventLookupSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.cycle.EventCyclicEventLookupSession | an EventCyclicEventLookupSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventCyclicEventLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsEventCyclicEventLookup()
and supportsVisibleFederation() are true.
| |
Method | getEventCyclicEventAssignmentSession | ||
Description |
Gets the session for manually making event to cyclic event associations. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.cycle.EventCyclicEventAssignmentSession | an EventCyclicEventAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventCyclicEventAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsEventCyclicEventAssignment() is true. | |
Method | getEventCyclicEventAssignmentSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.cycle.EventCyclicEventAssignmentSession | an EventCyclicEventAssignmentSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEventCyclicEventAssignment() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsEventCyclicEventAssignment() and
supportsVisibleFederation() are true. | |
Method | getCyclicTimePeriodLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.cycle.CyclicTimePeriodLookupSession | a CyclicTimePeriodLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCyclicTimePeriodLookup() is false | ||
Compliance | optional | This method must be implemented if supportsCyclicTimePeriodLookup()
is true. | |
Method | getCyclicTimePeriodLookupSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.cycle.CyclicTimePeriodLookupSession | a CyclicTimePeriodLookupSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCyclicTimePeriodLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCyclicTimePeriodLookup()
and supportsVisibleFederation() are true.
| |
Method | getCyclicTimePeriodQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.cycle.CyclicTimePeriodQuerySession | a CyclicTimePeriodQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCyclicTimePeriodQuery() is false | ||
Compliance | optional | This method must be implemented if supportsCyclicTimePeriodQuery()
is true. | |
Method | getCyclicTimePeriodQuerySessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.cycle.CyclicTimePeriodQuerySession | a CyclicTimePeriodQuerySession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCyclicTimePeriodQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCyclicTimePeriodQuery()
and supportsVisibleFederation() are true.
| |
Method | getCyclicTimePeriodSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.cycle.CyclicTimePeriodSearchSession | a CyclicTimePeriodSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCyclicTimePeriodSearch() is false | ||
Compliance | optional | This method must be implemented if supportsCyclicTimePeriodSearch()
is true. | |
Method | getCyclicTimePeriodSearchSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.cycle.CyclicTimePeriodSearchSession | a CyclicTimePeriodSearchSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCyclicTimePeriodSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCyclicTimePeriodSearch()
and supportsVisibleFederation() are true.
| |
Method | getCyclicTimePeriodAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.cycle.CyclicTimePeriodAdminSession | a CyclicTimePeriodAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCyclicTimePeriodAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsCyclicTimePeriodAdmin()
is true. | |
Method | getCyclicTimePeriodAdminSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.cycle.CyclicTimePeriodAdminSession | calendarId not found | |
Errors | NOT_FOUND | a CyclicTimePeriodAdminSession | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCyclicTimePeriodAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCyclicTimePeriodAdmin()
and supportsVisibleFederation() are true.
| |
Method | getCyclicTimePeriodNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to cyclic time period changes. | ||
Parameters | osid.calendaring.cycle.CyclicTimePeriodReceiver | cyclicTimePeriodReceiver | the cyclic time period receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.cycle.CyclicTimePeriodNotificationSession | a CyclicTimePeriodNotificationSession | |
Errors | NULL_ARGUMENT | cyclicTimePeriodReceiver or proxy is
null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCyclicTimePeriodNotification() is false
| ||
Compliance | optional | This method must be implemented if
supportsCyclicTimePeriodNotification() is true. | |
Method | getCyclicTimePeriodNotificationSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.calendaring.cycle.CyclicTimePeriodReceiver | cyclicTimePeriodReceiver | the cyclic time period receiver |
osid.id.Id | calendarId | the Id of the calendar | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.cycle.CyclicTimePeriodNotificationSession | a CyclicTimePeriodNotificationSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | cyclicTimePeriodReceiver or calendarId or
proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCyclicTimePeriodNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsCyclicTimePeriodNotification() and
supportsVisibleFederation() are true. | |
Method | getCyclicTimePeriodCalendarSession | ||
Description |
Gets the session for retrieving cyclic time period to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.cycle.CyclicTimePeriodCalendarSession | a CyclicTimePeriodCalendarSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCyclicTimePeriodCalendar() is false | ||
Compliance | optional | This method must be implemented if
supportsCyclicTimePeriodCalendar() is true. | |
Method | getCyclicTimePeriodCalendarAssignmentSession | ||
Description |
Gets the session for assigning cyclic time period to calendar mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.cycle.CyclicTimePeriodCalendarAssignmentSession | a CyclicTimePeriodCalendarAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCyclicTimePeriodCalendarAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsCyclicTimePeriodCalendarAssignment() is true. | |
Method | getCyclicTimePeriodSmartCalendarSession | ||
Description |
Gets the session associated with the cyclic 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.cycle.CyclicTimePeriodSmartCalendarSession | a CyclicTimePeriodSmartCalendarSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCyclicTimePeriodSmartCalendar() is false
| ||
Compliance | optional | This method must be implemented if
supportsCyclicTimePeriodSmartCalendar() is true. | |
Method | getTimePeriodCyclicTimePeriodLookupSession | ||
Description |
Gets the session for retrieving time period to cyclic time period associations. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.cycle.TimePeriodCyclicTimePeriodLookupSession | a TimePeriodCyclicTimePeriodLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTimePeriodCyclicTimePeriodLookup() is false
| ||
Compliance | optional | This method must be implemented if
supportsTimePeriodCyclicTimePeriodLookup() is true. | |
Method | getTimePeriodCyclicTimePeriodLookupSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.cycle.TimePeriodCyclicTimePeriodLookupSession | a TimePeriodCyclicTimePeriodLookupSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTimePeriodCyclicTimePeriodLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsTimePeriodCyclicTimePeriodLookup() and
supportsVisibleFederation() are true. | |
Method | getTimePeriodCyclicTimePeriodAssignmentSession | ||
Description |
Gets the session for manually making time period to cyclic time period associations. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.calendaring.cycle.TimePeriodCyclicTimePeriodAssignmentSession | a TimePeriodCyclicTimePeriodAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTimePeriodCyclicTimePeriodAssignment() is
false | ||
Compliance | optional | This method must be implemented if
supportsTimePeriodCyclicTimePeriodAssignment() is true. | |
Method | getTimePeriodCyclicTimePeriodAssignmentSessionForCalendar | ||
Description |
Gets the | ||
Parameters | osid.id.Id | calendarId | the Id of the calendar |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.calendaring.cycle.TimePeriodCyclicTimePeriodAssignmentSession | a TimePeriodCyclicTimePeriodAssignmentSession | |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTimePeriodCyclicTimePeriodAssignment() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsTimePeriodCyclicTimePeriodAssignment() and
supportsVisibleFederation() are true. | |
Method | getCalendaringCycleBatchProxyManager | ||
Description |
Gets a | ||
Return | osid.calendaring.cycle.batch.CalendaringCycleBatchProxyManager | a CalendaringCycleBatchProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCalendaringCycleBatch() is false | ||
Compliance | optional | This method must be implemented if supportsCalendaringCycleBatch()
is true. |