OSID - osid.course.ActivityUnitNotificationSession Service Interface Definition

Interface	osid.course.ActivityUnitNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.course.CourseManager`
Used By	`osid.course.CourseProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `ActivityUnits` in this `CourseCatalog`. This also includes existing activity units that may appear or disappear due to changes in the `CourseCatalog` hierarchy, 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 `ActivityUnitLookupSession`.
Method	getCourseCatalogId
Description	Gets the `CourseCatalog` `Id` associated with this session.
Return	`osid.id.Id`		the `CourseCatalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalog
Description	Gets the `CourseCatalog` associated with this session.
Return	`osid.course.CourseCatalog`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForActivityUnitNotifications
Description	Tests if this user can register for `ActivityUnit` 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	useFederatedCourseCatalogView
Description	Federates the view for methods in this session. A federated view will include activity units in catalogs which are children of this catalog in the course catalog hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCourseCatalogView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableActivityUnitNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeActivityUnitNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableActivityUnitNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeActivityUnitNotification
Description	Acknowledge an activity unit 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	registerForNewActivityUnits
Description	Register for notifications of new activity units. `ActivityUnitReceiver.newActivityUnits()` is invoked when a new `ActivityUnit` appears in this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewActivityUnitsForCourse
Description	Register for notifications of new activity units for the given course. `ActivityUnitReceiver.newActivityUnits()` is invoked when a new `ActivityUnit` appears in this course catalog.
Parameters	`osid.id.Id`	`courseId`	the `Id` of the `Course` to monitor
Errors	NULL_ARGUMENT		`courseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedActivityUnits
Description	Registers for notification of updated activity units. `ActivityUnitReceiver.changedActivityUnits()` is invoked when an activity unit in this course catalog is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedActivityUnitsForCourse
Description	Register for notifications of changed activity units for the given course. `ActivityUnitReceiver.changedActivityUnits()` is invoked when an activity unit in this course catalog is changed.
Parameters	`osid.id.Id`	`courseId`	the `Id` of the `Course` to monitor
Errors	NULL_ARGUMENT		`courseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedActivityUnit
Description	Registers for notification of an updated activity unit. `ActivityUnitReceiver.changedActivityUnits()` is invoked when the specified activity unit in this course catalog is changed.
Parameters	`osid.id.Id`	`activityUnitId`	the `Id` of the `ActivityUnit` to monitor
Errors	NULL_ARGUMENT		`activityUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedActivityUnits
Description	Registers for notification of deleted activity units. `ActivityUnitReceiver.deletedActivityUnits()` is invoked when an activity unit is deleted or removed from this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedActivityUnitsForCourse
Description	Register for notifications of deleted activity units for the given course. `ActivityUnitReceiver.changedActivityUnits()` is invoked when an activity unit is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`courseId`	the `Id` of the `Course` to monitor
Errors	NULL_ARGUMENT		`courseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedActivityUnit
Description	Registers for notification of a deleted activity unit. `ActivityUnitReceiver.deletedActivityUnits()` is invoked when the specified activity unit is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`activityUnitId`	the `Id` of the `ActivityUnit` to monitor
Errors	NULL_ARGUMENT		`activityUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.