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

Interface	osid.calendaring.cycle.CyclicTimePeriodNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.calendaring.cycle.CalendaringCycleManager`
Used By	`osid.calendaring.cycle.CalendaringCycleProxyManager`
Description	This session defines methods to receive asynchronous notifications on adds/changes to `CyclicTimePeriods`. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed. The two views defined in this session correspond to the views in the `CyclicTimePeriodLookupSession`.
Method	getCalendarId
Description	Gets the `Calendar` `Id` associated with this session.
Return	`osid.id.Id`		the `Calendar Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCalendar
Description	Gets the `Calendar` associated with this session.
Return	`osid.calendaring.Calendar`		the `Calendar` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForCyclicTimePeriodNotifications
Description	Tests if this user can register for `CyclicTimePeriod` notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer notification operations.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedCalendarView
Description	Federates the view for methods in this session. A federated view will include notifications for cyclic time periods in calendars which are children of this calendar in the calendar hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCalendarView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this calendar only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableCyclicTimePeriodNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeCyclicTimePeriodNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableCyclicTimePeriodNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeCyclicTimePeriodNotification
Description	Acknowledge a cyclic time period notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewCyclicTimePeriods
Description	Register for notifications of new cyclic time periods. `CyclicTimePeriodReceiver.newCyclicTimePeriods()` is invoked when a new cyclic time period is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCyclicTimePeriods
Description	Registers for notification of updated cyclic time periods. `CyclicTimePeriodReceiver.changedCyclicTimePeriods()` is invoked when a cyclic time period is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCyclicTimePeriod
Description	Registers for notification of an updated cyclic time period. `CyclicTimePeriodReceiver.changedCyclicTimePeriods()` is invoked when the specified cyclic time period is changed.
Parameters	`osid.id.Id`	`cyclicTimePeriodId`	the `Id` of the `CyclicTimePeriod` to monitor
Errors	NULL_ARGUMENT		`cyclicTimePeriodId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCyclicTimePeriods
Description	Registers for notification of deleted cyclic time periods. `CyclicTimePeriodReceiver.deletedCyclicTimePeriods()` is invoked when a cyclic time period is removed from this calendar.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCyclicTimePeriod
Description	Registers for notification of a deleted cyclic time period. `CyclicTimePeriodReceiver.changedCyclicTimePeriods()` is invoked when the specified cyclic time period is removed from this calendar.
Parameters	`osid.id.Id`	`cyclicTimePeriodId`	the `Id` of the `CyclicTimePeriod` to monitor
Errors	NULL_ARGUMENT		`cyclicTimePeriodId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.