OSID - osid.course.registration.ActivityBundleNotificationSession Service Interface Definition

Interface	osid.course.registration.ActivityBundleNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `ActivityBundle` objects in this `CourseCatalog.` This also includes existing activity bundles 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 `ActivityBundleLookupSession.`
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	canRegisterForActivityBundleNotifications
Description	Tests if this user can register for `ActivityBundle` 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 bundles 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	reliableActivityBundleNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeActivityBundleNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableActivityBundleNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeActivityBundleNotification
Description	Acknowledge an activity bundle 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	registerForNewActivityBundles
Description	Register for notifications of new activity bundles. `ActivityBundleReceiver.newActivityBundles()` is invoked when a new `ActivityBundle` 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	registerForNewActivityBundlesForCourseOffering
Description	Register for notifications of new activity bundles for the given course offering. `ActivityBundleReceiver.newActivityBundles()` is invoked when a new `ActivityBundle` appears in this course catalog.
Parameters	`osid.id.Id`	`courseOfferingId`	the `Id` of a `CourseOffering`
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewActivityBundlesForActivity
Description	Register for notifications of new activity bundles for the given activity. `ActivityBundleReceiver.newActivityBundles()` is invoked when a new `ActivityBundle` appears in this course catalog.
Parameters	`osid.id.Id`	`activityId`	the `Id` of an activity
Errors	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedActivityBundles
Description	Registers for notification of updated activity bundles. `ActivityBundleReceiver.changedActivityBundles()` is invoked when an activity bundle 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	registerForChangedActivityBundlesForCourseOffering
Description	Registers for notification of updated activity bundles for the given course offering. `ActivityBundleReceiver.changedActivityBundles()` is invoked when an activity bundle in this course catalog is changed.
Parameters	`osid.id.Id`	`courseOfferingId`	the `Id` of a `CourseOffering`
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedActivityBundlesForActivity
Description	Registers for notification of updated activity bundles for the given activity. `ActivityBundleReceiver.changedActivityBundles()` is invoked when an activity bundle in this course catalog is changed.
Parameters	`osid.id.Id`	`activityId`	the `Id` of an `Activity`
Errors	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedActivityBundle
Description	Registers for notification of an updated activity bundle. `ActivityBundleReceiver.changedActivityBundles()` is invoked when the specified activity bundle in this course catalog is changed.
Parameters	`osid.id.Id`	`activityBundleId`	the `Id` of the `ActivityBundle` to monitor
Errors	NULL_ARGUMENT		`activityBundleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedActivityBundles
Description	Registers for notification of deleted activity bundles. `ActivityBundleReceiver.deletedActivityBundles()` is invoked when an activity bundle 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	registerForDeletedActivityBundlesForCourseOffering
Description	Registers for notification of a deleted activity bundle for the given course offering. `ActivityBundleReceiver.changedActivityBundles()` is invoked when the specified activity bundle in this course catalog is changed.
Parameters	`osid.id.Id`	`courseOfferingId`	the `Id` of the `CourseOffering` to monitor
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedActivityBundlesForActivity
Description	Registers for notification of a deleted activity bundle for the given activity. `ActivityBundleReceiver.changedActivityBundles()` is invoked when the specified activity bundle in this course catalog is changed.
Parameters	`osid.id.Id`	`activityId`	the `Id` of the `Activity` to monitor
Errors	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedActivityBundle
Description	Registers for notification of a deleted activity bundle. `ActivityBundleReceiver.deletedActivityBundles()` is invoked when the specified activity bundle is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`activityBundleId`	the `Id` of the `ActivityBundle` to monitor
Errors	NULL_ARGUMENT		`activityBundleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.