OSID Logo
OSID Specifications
calendaring cycle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.cycle.CalendaringCycleManager
Implementsosid.OsidManager
osid.calendaring.cycle.CalendaringCycleProfile
Description

The calendaring cycle manager provides access to calendaring cycle sessions and provides interoperability tests for various aspects of this service. 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
  • EventCyclicEventLookupSession: a session to look up the associations between events and cyclic events
  • EventCyclicEventAssignmentSession: a session to manually map events to cyclic events
  • 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
  • TimePeriodCyclicTimePeriodLookupSession: a session to look up the associations between time periods and cyclic time periods
  • TimePeriodCyclicTimePeriodAssignmentSession: a session to manually map time periods to cyclic time periods
MethodgetCyclicEventLookupSession
Description

Gets the OsidSession associated with the cyclic event lookup service.

Returnosid.calendaring.cycle.CyclicEventLookupSessiona CyclicEventLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicEventLookup() is false
ComplianceoptionalThis method must be implemented if supportsCyclicEventLookup() 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
Returnosid.calendaring.cycle.CyclicEventLookupSessiona CyclicEventLookupSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCyclicEventLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCyclicEventLookup() and supportsVisibleFederation() are true.
MethodgetCyclicEventQuerySession
Description

Gets the OsidSession associated with the cyclic event query service.

Returnosid.calendaring.cycle.CyclicEventQuerySessiona CyclicEventQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicEventQuery() is false
ComplianceoptionalThis method must be implemented if supportsCyclicEventQuery() 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
Returnosid.calendaring.cycle.CyclicEventQuerySessiona CyclicEventQuerySession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCyclicEventQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCyclicEventQuery() and supportsVisibleFederation() are true.
MethodgetCyclicEventSearchSession
Description

Gets the OsidSession associated with the cyclic event search service.

Returnosid.calendaring.cycle.CyclicEventSearchSessiona CyclicEventSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicEventSearch() is false
ComplianceoptionalThis method must be implemented if supportsCyclicEventSearch() 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
Returnosid.calendaring.cycle.CyclicEventSearchSessiona CyclicEventSearchSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCyclicEventSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCyclicEventSearch() and supportsVisibleFederation() are true.
MethodgetCyclicEventAdminSession
Description

Gets the OsidSession associated with the cyclic event administration service.

Returnosid.calendaring.cycle.CyclicEventAdminSessiona CyclicEventAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicEventAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCyclicEventAdmin() 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
Returnosid.calendaring.cycle.CyclicEventAdminSessiona CyclicEventAdminSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCyclicEventAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCyclicEventAdmin() and supportsVisibleFederation() are true.
MethodgetCyclicEventNotificationSession
Description

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

Parametersosid.calendaring.cycle.CyclicEventReceivercyclicEventReceiverthe cyclic event receiver
Returnosid.calendaring.cycle.CyclicEventNotificationSessiona CyclicEventNotificationSession
ErrorsNULL_ARGUMENT cyclicEventReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicEventNotification() is false
ComplianceoptionalThis method must be implemented if supportsCyclicEventNotification() is true.
MethodgetCyclicEventNotificationSessionForCalendar
Description

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

Parametersosid.calendaring.cycle.CyclicEventReceivercyclicEventReceiverthe cyclic event receiver
osid.id.IdcalendarIdthe Id of the calendar
Returnosid.calendaring.cycle.CyclicEventNotificationSessiona CyclicEventNotificationSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT cyclicEventReceiver or calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCyclicEventNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCyclicEventNotification() and supportsVisibleFederation() are true.
MethodgetCyclicEventCalendarSession
Description

Gets the session for retrieving cyclic event to calendar mappings.

Returnosid.calendaring.cycle.CyclicEventCalendarSessiona CyclicEventCalendarSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicEventCalendar() is false
ComplianceoptionalThis method must be implemented if supportsCyclicEventCalendar() is true.
MethodgetCyclicEventCalendarAssignmentSession
Description

Gets the session for assigning event to calendar mappings.

Returnosid.calendaring.cycle.CyclicEventCalendarAssignmentSessiona CyclicEventCalendarAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicEventCalendarAssignment() is false
ComplianceoptionalThis method must be implemented if supportsCyclicEventCalendarAssignment() 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
Returnosid.calendaring.cycle.CyclicEventSmartCalendarSessiona CyclicEventSmartCalendarSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicEventSmartCalendar() is false
ComplianceoptionalThis method must be implemented if supportsCyclicEventSmartCalendar() is true.
MethodgetEventCyclicEventLookupSession
Description

Gets the session for retrieving event to cyclic event associations.

Returnosid.calendaring.cycle.EventCyclicEventLookupSessionan EventCyclicEventLookupSession
ErrorsOPERATION_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
Returnosid.calendaring.cycle.EventCyclicEventLookupSessionan EventCyclicEventLookupSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId 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.

Returnosid.calendaring.cycle.EventCyclicEventAssignmentSessionan EventCyclicEventAssignmentSession
ErrorsOPERATION_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
Returnosid.calendaring.cycle.EventCyclicEventAssignmentSessionan EventCyclicEventAssignmentSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId 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.

Returnosid.calendaring.cycle.CyclicTimePeriodLookupSessiona CyclicTimePeriodLookupSession
ErrorsOPERATION_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
Returnosid.calendaring.cycle.CyclicTimePeriodLookupSessiona CyclicTimePeriodLookupSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId 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.

Returnosid.calendaring.cycle.CyclicTimePeriodQuerySessiona CyclicTimePeriodQuerySession
ErrorsOPERATION_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
Returnosid.calendaring.cycle.CyclicTimePeriodQuerySessiona CyclicTimePeriodQuerySession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId 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.

Returnosid.calendaring.cycle.CyclicTimePeriodSearchSessiona CyclicTimePeriodSearchSession
ErrorsOPERATION_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
Returnosid.calendaring.cycle.CyclicTimePeriodSearchSessiona CyclicTimePeriodSearchSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId 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.

Returnosid.calendaring.cycle.CyclicTimePeriodAdminSessiona CyclicTimePeriodAdminSession
ErrorsOPERATION_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
Returnosid.calendaring.cycle.CyclicTimePeriodAdminSessiona CyclicTimePeriodAdminSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId 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
Returnosid.calendaring.cycle.CyclicTimePeriodNotificationSessiona CyclicTimePeriodNotificationSession
ErrorsNULL_ARGUMENT cyclicTimePeriodReceiver 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
Returnosid.calendaring.cycle.CyclicTimePeriodNotificationSession a CyclicTimePeriodNotificationSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT cyclicTimePeriodReceiver or calendarId 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.

Returnosid.calendaring.cycle.CyclicTimePeriodCalendarSessiona CyclicTimePeriodCalendarSession
ErrorsOPERATION_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.

Returnosid.calendaring.cycle.CyclicTimePeriodCalendarAssignmentSessiona CyclicTimePeriodCalendarAssignmentSession
ErrorsOPERATION_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
Returnosid.calendaring.cycle.CyclicTimePeriodSmartCalendarSessiona CyclicTimePeriodSmartCalendarSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId 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.

Returnosid.calendaring.cycle.TimePeriodCyclicTimePeriodLookupSessiona TimePeriodCyclicTimePeriodLookupSession
ErrorsOPERATION_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
Returnosid.calendaring.cycle.TimePeriodCyclicTimePeriodLookupSessiona TimePeriodCyclicTimePeriodLookupSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId 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.

Returnosid.calendaring.cycle.TimePeriodCyclicTimePeriodAssignmentSessiona TimePeriodCyclicTimePeriodAssignmentSession
ErrorsOPERATION_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
Returnosid.calendaring.cycle.TimePeriodCyclicTimePeriodAssignmentSessiona TimePeriodCyclicTimePeriodAssignmentSession
ErrorsNOT_FOUND calendarId not found
NULL_ARGUMENT calendarId 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.
MethodgetCalendaringCycleBatchManager
Description

Gets a CalendaringCycleBatchManager.

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