OSID Logo
OSID Specifications
calendaring cycle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.cycle.CalendaringCycleProxyManager
Implementsosid.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 Proxy object. The sessions included in this manager are:

  • CyclicEventLookupSession: a session to look up cyclic events
  • CyclicEventQuerySession: a session to query cyclic events
  • CyclicEventSearchSession: a session to search cyclic events
  • CyclicEventAdminSession: a session to create, modify and delete cyclic events
  • CyclicEventNotificationSession: a session to receive messages pertaining to cyclic event changes
  • CyclicEventCalendarSession: a session for retriieving cyclic event and calendar mappings
  • CyclicEventCalendarAssignmentSession: a session for managing cyclic event and calendar mappings
  • CyclicEventSmartCalendarSession: a session to manage dynamic cyclic event catalogs
  • CyclicTimePeriodLookupSession: a session to look up cyclic time periods
  • CyclicTimePeriodQuerySession: a session to query cyclic time periods
  • CyclicTimePeriodSearchSession: a session to search cyclic time periods
  • CyclicTimePeriodAdminSession: a session to create, modify and delete cyclic time periods
  • CyclicTimePeriodNotificationSession: a session to receive messages pertaining to cyclic time period changes
  • CyclicTimePeriodCalendarSession: a session for retriieving cyclic time period and calendar mappings
  • CyclicTimePeriodCalendarAssignmentSession: a session for managing cyclic time period and calendar mappings
  • CyclicTimePeriodSmartCalendarSession: a session to manage dynamic cyclic time period catalogs
MethodgetCyclicEventLookupSession
Description

Gets the OsidSession associated with the cyclic event lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicEventLookupSessionan EventLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventLookup() is false
ComplianceoptionalThis method must be implemented if supportsEventLookup() is true.
MethodgetCyclicEventLookupSessionForCalendar
Description

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

Parametersosid.id.IdcalendarIdthe Id of the calendar
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicEventLookupSession CyclicEventLookupSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId or proxy 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.
MethodgetCyclicEventQuerySession
Description

Gets the OsidSession associated with the cyclic event query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicEventQuerySessionan EventQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventQuery() is false
ComplianceoptionalThis method must be implemented if supportsEventQuery() is true.
MethodgetCyclicEventQuerySessionForCalendar
Description

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

Parametersosid.id.IdcalendarIdthe Id of the calendar
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicEventQuerySession CyclicEventQuerySession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId or proxy 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.
MethodgetCyclicEventSearchSession
Description

Gets the OsidSession associated with the cyclic event search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicEventSearchSessionan EventSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventSearch() is false
ComplianceoptionalThis method must be implemented if supportsEventSearch() is true.
MethodgetCyclicEventSearchSessionForCalendar
Description

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

Parametersosid.id.IdcalendarIdthe Id of the calendar
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicEventSearchSession CyclicEventSearchSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId or proxy 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.
MethodgetCyclicEventAdminSession
Description

Gets the OsidSession associated with the cyclic event administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicEventAdminSessionan EventAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventAdmin() is false
ComplianceoptionalThis method must be implemented if supportsEventAdmin() is true.
MethodgetCyclicEventAdminSessionForCalendar
Description

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

Parametersosid.id.IdcalendarIdthe Id of the calendar
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicEventAdminSession CyclicEventAdminSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId or proxy 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.
MethodgetCyclicEventNotificationSession
Description

Gets the notification session for notifications pertaining to event changes.

Parametersosid.calendaring.cycle.CyclicEventReceivereventReceiverthe cyclic event receiver
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicEventNotificationSessionan EventNotificationSession
ErrorsNULL_ARGUMENT eventReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventNotification() is false
ComplianceoptionalThis method must be implemented if supportsEventNotification() is true.
MethodgetCyclicEventNotificationSessionForCalendar
Description

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

Parametersosid.calendaring.cycle.CyclicEventReceivereventReceiverthe cyclic event receiver
osid.id.IdcalendarIdthe Id of the calendar
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicEventNotificationSession CyclicEventNotificationSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT eventReceiver, calendarId or proxy 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.
MethodgetCyclicEventCalendarSession
Description

Gets the session for retrieving event to calendar mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicEventCalendarSessionan EventCalendarSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventCalendar() is false
ComplianceoptionalThis method must be implemented if supportsEventCalendar() is true.
MethodgetCyclicEventCalendarAssignmentSession
Description

Gets the session for assigning event to calendar mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicEventCalendarAssignmentSessionan EventCalendarAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventCalendarAssignment() is false
ComplianceoptionalThis method must be implemented if supportsEventCalendarAssignment() is true.
MethodgetCyclicEventSmartCalendarSession
Description

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

Parametersosid.id.IdcalendarIdthe Id of the calendar
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicEventSmartCalendarSessionan EventSmartCalendarSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventSmartCalendar() is false
ComplianceoptionalThis method must be implemented if supportsEventSmartCalendar() is true.
MethodgetEventCyclicEventLookupSession
Description

Gets the session for retrieving event to cyclic event associations.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.EventCyclicEventLookupSessionan EventCyclicEventLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventCyclicEventLookup() is false
ComplianceoptionalThis method must be implemented if supportsEventCyclicEventLookup() is true.
MethodgetEventCyclicEventLookupSessionForCalendar
Description

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

Parametersosid.id.IdcalendarIdthe Id of the calendar
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.EventCyclicEventLookupSessionan EventCyclicEventLookupSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEventCyclicEventLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEventCyclicEventLookup() and supportsVisibleFederation() are true.
MethodgetEventCyclicEventAssignmentSession
Description

Gets the session for manually making event to cyclic event associations.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.EventCyclicEventAssignmentSessionan EventCyclicEventAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventCyclicEventAssignment() is false
ComplianceoptionalThis method must be implemented if supportsEventCyclicEventAssignment() is true.
MethodgetEventCyclicEventAssignmentSessionForCalendar
Description

Gets the OsidSession associated with the event cyclic event assignment service for the given calendar.

Parametersosid.id.IdcalendarIdthe Id of the calendar
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.EventCyclicEventAssignmentSessionan EventCyclicEventAssignmentSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEventCyclicEventAssignment() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEventCyclicEventAssignment() and supportsVisibleFederation() are true.
MethodgetCyclicTimePeriodLookupSession
Description

Gets the OsidSession associated with the cyclic time period lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicTimePeriodLookupSessiona CyclicTimePeriodLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicTimePeriodLookup() is false
ComplianceoptionalThis method must be implemented if supportsCyclicTimePeriodLookup() is true.
MethodgetCyclicTimePeriodLookupSessionForCalendar
Description

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

Parametersosid.id.IdcalendarIdthe Id of the calendar
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicTimePeriodLookupSessiona CyclicTimePeriodLookupSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCyclicTimePeriodLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCyclicTimePeriodLookup() and supportsVisibleFederation() are true.
MethodgetCyclicTimePeriodQuerySession
Description

Gets the OsidSession associated with the cyclic time period query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicTimePeriodQuerySessiona CyclicTimePeriodQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicTimePeriodQuery() is false
ComplianceoptionalThis method must be implemented if supportsCyclicTimePeriodQuery() is true.
MethodgetCyclicTimePeriodQuerySessionForCalendar
Description

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

Parametersosid.id.IdcalendarIdthe Id of the calendar
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicTimePeriodQuerySessiona CyclicTimePeriodQuerySession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCyclicTimePeriodQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCyclicTimePeriodQuery() and supportsVisibleFederation() are true.
MethodgetCyclicTimePeriodSearchSession
Description

Gets the OsidSession associated with the cyclic time period search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicTimePeriodSearchSessiona CyclicTimePeriodSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicTimePeriodSearch() is false
ComplianceoptionalThis method must be implemented if supportsCyclicTimePeriodSearch() is true.
MethodgetCyclicTimePeriodSearchSessionForCalendar
Description

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

Parametersosid.id.IdcalendarIdthe Id of the calendar
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicTimePeriodSearchSessiona CyclicTimePeriodSearchSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCyclicTimePeriodSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCyclicTimePeriodSearch() and supportsVisibleFederation() are true.
MethodgetCyclicTimePeriodAdminSession
Description

Gets the OsidSession associated with the cyclic time period administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicTimePeriodAdminSessiona CyclicTimePeriodAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicTimePeriodAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCyclicTimePeriodAdmin() is true.
MethodgetCyclicTimePeriodAdminSessionForCalendar
Description

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

Parametersosid.id.IdcalendarIdthe Id of the calendar
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicTimePeriodAdminSession calendarId not found
ErrorsNOT_FOUNDa CyclicTimePeriodAdminSession
NULL_ARGUMENT calendarId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCyclicTimePeriodAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCyclicTimePeriodAdmin() and supportsVisibleFederation() are true.
MethodgetCyclicTimePeriodNotificationSession
Description

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

Parametersosid.calendaring.cycle.CyclicTimePeriodReceivercyclicTimePeriodReceiverthe cyclic time period receiver
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicTimePeriodNotificationSessiona CyclicTimePeriodNotificationSession
ErrorsNULL_ARGUMENT cyclicTimePeriodReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicTimePeriodNotification() is false
ComplianceoptionalThis method must be implemented if supportsCyclicTimePeriodNotification() is true.
MethodgetCyclicTimePeriodNotificationSessionForCalendar
Description

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

Parametersosid.calendaring.cycle.CyclicTimePeriodReceivercyclicTimePeriodReceiverthe cyclic time period receiver
osid.id.IdcalendarIdthe Id of the calendar
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicTimePeriodNotificationSession a CyclicTimePeriodNotificationSession
ErrorsNOT_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
ComplianceoptionalThis method must be implemented if supportsCyclicTimePeriodNotification() and supportsVisibleFederation() are true.
MethodgetCyclicTimePeriodCalendarSession
Description

Gets the session for retrieving cyclic time period to calendar mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicTimePeriodCalendarSessiona CyclicTimePeriodCalendarSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicTimePeriodCalendar() is false
ComplianceoptionalThis method must be implemented if supportsCyclicTimePeriodCalendar() is true.
MethodgetCyclicTimePeriodCalendarAssignmentSession
Description

Gets the session for assigning cyclic time period to calendar mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicTimePeriodCalendarAssignmentSessiona CyclicTimePeriodCalendarAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicTimePeriodCalendarAssignment() is false
ComplianceoptionalThis method must be implemented if supportsCyclicTimePeriodCalendarAssignment() is true.
MethodgetCyclicTimePeriodSmartCalendarSession
Description

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

Parametersosid.id.IdcalendarIdthe Id of the calendar
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.CyclicTimePeriodSmartCalendarSessiona CyclicTimePeriodSmartCalendarSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicTimePeriodSmartCalendar() is false
ComplianceoptionalThis method must be implemented if supportsCyclicTimePeriodSmartCalendar() is true.
MethodgetTimePeriodCyclicTimePeriodLookupSession
Description

Gets the session for retrieving time period to cyclic time period associations.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.TimePeriodCyclicTimePeriodLookupSessiona TimePeriodCyclicTimePeriodLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTimePeriodCyclicTimePeriodLookup() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodCyclicTimePeriodLookup() is true.
MethodgetTimePeriodCyclicTimePeriodLookupSessionForCalendar
Description

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

Parametersosid.id.IdcalendarIdthe Id of the calendar
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.TimePeriodCyclicTimePeriodLookupSessiona TimePeriodCyclicTimePeriodLookupSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTimePeriodCyclicTimePeriodLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodCyclicTimePeriodLookup() and supportsVisibleFederation() are true.
MethodgetTimePeriodCyclicTimePeriodAssignmentSession
Description

Gets the session for manually making time period to cyclic time period associations.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.TimePeriodCyclicTimePeriodAssignmentSessiona TimePeriodCyclicTimePeriodAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTimePeriodCyclicTimePeriodAssignment() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodCyclicTimePeriodAssignment() is true.
MethodgetTimePeriodCyclicTimePeriodAssignmentSessionForCalendar
Description

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

Parametersosid.id.IdcalendarIdthe Id of the calendar
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.TimePeriodCyclicTimePeriodAssignmentSessiona TimePeriodCyclicTimePeriodAssignmentSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTimePeriodCyclicTimePeriodAssignment() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodCyclicTimePeriodAssignment() and supportsVisibleFederation() are true.
MethodgetCalendaringCycleBatchProxyManager
Description

Gets a CalendaringCycleBatchProxyManager.

Returnosid.calendaring.cycle.batch.CalendaringCycleBatchProxyManagera CalendaringCycleBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCalendaringCycleBatch() is false
ComplianceoptionalThis method must be implemented if supportsCalendaringCycleBatch() is true.