OSID - osid.calendaring.cycle.CalendaringCycleManager Service Interface Definition

Interface	osid.calendaring.cycle.CalendaringCycleManager
Implements	`osid.OsidManager`
Implements	`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
Method	getCyclicEventLookupSession
Description	Gets the `OsidSession` associated with the cyclic event lookup service.
Return	`osid.calendaring.cycle.CyclicEventLookupSession`		a `CyclicEventLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCyclicEventLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicEventLookup()` is `true.`
Method	getCyclicEventLookupSessionForCalendar
Description	Gets the `OsidSession` associated with the cyclic event lookup service for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the calendar
Return	`osid.calendaring.cycle.CyclicEventLookupSession`		a `CyclicEventLookupSession`
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsCyclicEventLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicEventLookup()` and `supportsVisibleFederation()` are `true.`
Method	getCyclicEventQuerySession
Description	Gets the `OsidSession` associated with the cyclic event query service.
Return	`osid.calendaring.cycle.CyclicEventQuerySession`		a `CyclicEventQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCyclicEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicEventQuery()` is `true.`
Method	getCyclicEventQuerySessionForCalendar
Description	Gets the `OsidSession` associated with the cyclic event query service for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the calendar
Return	`osid.calendaring.cycle.CyclicEventQuerySession`		a `CyclicEventQuerySession`
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsCyclicEventQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicEventQuery()` and `supportsVisibleFederation()` are `true.`
Method	getCyclicEventSearchSession
Description	Gets the `OsidSession` associated with the cyclic event search service.
Return	`osid.calendaring.cycle.CyclicEventSearchSession`		a `CyclicEventSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCyclicEventSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicEventSearch()` is `true.`
Method	getCyclicEventSearchSessionForCalendar
Description	Gets the `OsidSession` associated with the cyclic event search service for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the calendar
Return	`osid.calendaring.cycle.CyclicEventSearchSession`		a `CyclicEventSearchSession`
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsCyclicEventSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicEventSearch()` and `supportsVisibleFederation()` are `true.`
Method	getCyclicEventAdminSession
Description	Gets the `OsidSession` associated with the cyclic event administration service.
Return	`osid.calendaring.cycle.CyclicEventAdminSession`		a `CyclicEventAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCyclicEventAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicEventAdmin()` is `true.`
Method	getCyclicEventAdminSessionForCalendar
Description	Gets the `OsidSession` associated with the cyclic event admin service for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the calendar
Return	`osid.calendaring.cycle.CyclicEventAdminSession`		a `CyclicEventAdminSession`
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsCyclicEventAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicEventAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getCyclicEventNotificationSession
Description	Gets the notification session for notifications pertaining to cyclic event changes.
Parameters	`osid.calendaring.cycle.CyclicEventReceiver`	`cyclicEventReceiver`	the cyclic event receiver
Return	`osid.calendaring.cycle.CyclicEventNotificationSession`		a `CyclicEventNotificationSession`
Errors	NULL_ARGUMENT		`cyclicEventReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCyclicEventNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicEventNotification()` is `true.`
Method	getCyclicEventNotificationSessionForCalendar
Description	Gets the `OsidSession` associated with the cyclic event notification service for the given calendar.
Parameters	`osid.calendaring.cycle.CyclicEventReceiver`	`cyclicEventReceiver`	the cyclic event receiver
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the calendar
Return	`osid.calendaring.cycle.CyclicEventNotificationSession`		a `CyclicEventNotificationSession`
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`cyclicEventReceiver` or `calendarId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsCyclicEventNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicEventNotification()` and `supportsVisibleFederation()` are `true.`
Method	getCyclicEventCalendarSession
Description	Gets the session for retrieving cyclic event to calendar mappings.
Return	`osid.calendaring.cycle.CyclicEventCalendarSession`		a `CyclicEventCalendarSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCyclicEventCalendar()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicEventCalendar()` is `true.`
Method	getCyclicEventCalendarAssignmentSession
Description	Gets the session for assigning event to calendar mappings.
Return	`osid.calendaring.cycle.CyclicEventCalendarAssignmentSession`		a `CyclicEventCalendarAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCyclicEventCalendarAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicEventCalendarAssignment()` 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
Return	`osid.calendaring.cycle.CyclicEventSmartCalendarSession`		a `CyclicEventSmartCalendarSession`
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCyclicEventSmartCalendar()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicEventSmartCalendar()` is `true.`
Method	getEventCyclicEventLookupSession
Description	Gets the session for retrieving event to cyclic event associations.
Return	`osid.calendaring.cycle.EventCyclicEventLookupSession`		an `EventCyclicEventLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEventCyclicEventLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEventCyclicEventLookup()` is `true.`
Method	getEventCyclicEventLookupSessionForCalendar
Description	Gets the `OsidSession` associated with the event cyclic event lookup service for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the calendar
Return	`osid.calendaring.cycle.EventCyclicEventLookupSession`		an `EventCyclicEventLookupSession`
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`calendarId` 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.
Return	`osid.calendaring.cycle.EventCyclicEventAssignmentSession`		an `EventCyclicEventAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEventCyclicEventAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEventCyclicEventAssignment()` is `true.`
Method	getEventCyclicEventAssignmentSessionForCalendar
Description	Gets the `OsidSession` associated with the event cyclic event assignment service for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the calendar
Return	`osid.calendaring.cycle.EventCyclicEventAssignmentSession`		an `EventCyclicEventAssignmentSession`
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`calendarId` 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 `OsidSession` associated with the cyclic time period lookup service.
Return	`osid.calendaring.cycle.CyclicTimePeriodLookupSession`		a `CyclicTimePeriodLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCyclicTimePeriodLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicTimePeriodLookup()` is `true.`
Method	getCyclicTimePeriodLookupSessionForCalendar
Description	Gets the `OsidSession` associated with the cyclic time period lookup service for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the calendar
Return	`osid.calendaring.cycle.CyclicTimePeriodLookupSession`		a `CyclicTimePeriodLookupSession`
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`calendarId` 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 `OsidSession` associated with the cyclic time period query service.
Return	`osid.calendaring.cycle.CyclicTimePeriodQuerySession`		a `CyclicTimePeriodQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCyclicTimePeriodQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicTimePeriodQuery()` is `true.`
Method	getCyclicTimePeriodQuerySessionForCalendar
Description	Gets the `OsidSession` associated with the cyclic time period query service for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the calendar
Return	`osid.calendaring.cycle.CyclicTimePeriodQuerySession`		a `CyclicTimePeriodQuerySession`
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`calendarId` 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 `OsidSession` associated with the cyclic time period search service.
Return	`osid.calendaring.cycle.CyclicTimePeriodSearchSession`		a `CyclicTimePeriodSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCyclicTimePeriodSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicTimePeriodSearch()` is `true.`
Method	getCyclicTimePeriodSearchSessionForCalendar
Description	Gets the `OsidSession` associated with the cyclic time period search service for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the calendar
Return	`osid.calendaring.cycle.CyclicTimePeriodSearchSession`		a `CyclicTimePeriodSearchSession`
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`calendarId` 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 `OsidSession` associated with the cyclic time period administration service.
Return	`osid.calendaring.cycle.CyclicTimePeriodAdminSession`		a `CyclicTimePeriodAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCyclicTimePeriodAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicTimePeriodAdmin()` is `true.`
Method	getCyclicTimePeriodAdminSessionForCalendar
Description	Gets the `OsidSession` associated with the cyclic time period admin service for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the calendar
Return	`osid.calendaring.cycle.CyclicTimePeriodAdminSession`		a `CyclicTimePeriodAdminSession`
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`calendarId` 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
Return	`osid.calendaring.cycle.CyclicTimePeriodNotificationSession`		a `CyclicTimePeriodNotificationSession`
Errors	NULL_ARGUMENT		`cyclicTimePeriodReceiver` 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 `OsidSession` associated with the cyclic time period notification service for the given calendar.
Parameters	`osid.calendaring.cycle.CyclicTimePeriodReceiver`	`cyclicTimePeriodReceiver`	the cyclic time period receiver
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the calendar
Return	`osid.calendaring.cycle.CyclicTimePeriodNotificationSession`		`a CyclicTimePeriodNotificationSession`
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`cyclicTimePeriodReceiver` or `calendarId` 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.
Return	`osid.calendaring.cycle.CyclicTimePeriodCalendarSession`		a `CyclicTimePeriodCalendarSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	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.
Return	`osid.calendaring.cycle.CyclicTimePeriodCalendarAssignmentSession`		a `CyclicTimePeriodCalendarAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	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
Return	`osid.calendaring.cycle.CyclicTimePeriodSmartCalendarSession`		a `CyclicTimePeriodSmartCalendarSession`
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`calendarId` 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.
Return	`osid.calendaring.cycle.TimePeriodCyclicTimePeriodLookupSession`		a `TimePeriodCyclicTimePeriodLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTimePeriodCyclicTimePeriodLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTimePeriodCyclicTimePeriodLookup()` is `true.`
Method	getTimePeriodCyclicTimePeriodLookupSessionForCalendar
Description	Gets the `OsidSession` associated with the time period cyclic time period lookup service for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the calendar
Return	`osid.calendaring.cycle.TimePeriodCyclicTimePeriodLookupSession`		a `TimePeriodCyclicTimePeriodLookupSession`
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`calendarId` 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.
Return	`osid.calendaring.cycle.TimePeriodCyclicTimePeriodAssignmentSession`		a `TimePeriodCyclicTimePeriodAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTimePeriodCyclicTimePeriodAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTimePeriodCyclicTimePeriodAssignment()` is `true.`
Method	getTimePeriodCyclicTimePeriodAssignmentSessionForCalendar
Description	Gets the `OsidSession` associated with the time period cyclic time period assignment service for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the calendar
Return	`osid.calendaring.cycle.TimePeriodCyclicTimePeriodAssignmentSession`		a `TimePeriodCyclicTimePeriodAssignmentSession`
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`calendarId` 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	getCalendaringCycleBatchManager
Description	Gets a `CalendaringCycleBatchManager.`
Return	`osid.calendaring.cycle.batch.CalendaringCycleBatchManager`		a `CalendaringCycleBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCalendaringCycleBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCalendaringCycleBatch()` is `true.`