OSID - osid.course.ActivityNotificationSession Service Interface Definition

Interface	osid.course.ActivityNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Activity` objects in this `CourseCatalog.` This also includes existing activities 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 `ActivityLookupSession.`
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	canRegisterForActivityNotifications
Description	Tests if this user can register for `Activity` 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 activities 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	reliableActivityNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeActivityNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableActivityNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeActivityNotification
Description	Acknowledge an activity 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	registerForNewActivities
Description	Register for notifications of new activities. `ActivityReceiver.newActivities()` is invoked when a new `Activity` 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	registerForNewActivitiesForActivityUnit
Description	Register for notifications of new activities of the given activity unit. `ActivityReceiver.newActivities()` is invoked when a new `Activity` appears in this course catalog.
Parameters	`osid.id.Id`	`activityUnitId`	an activity unit `Id`
Errors	NULL_ARGUMENT		`activityUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewActivitiesForCourseOffering
Description	Register for notifications of new activities of the given course offering. `ActivityReceiver.newActivities()` is invoked when a new `Activity` appears in this course catalog.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewActivitiesForTerm
Description	Register for notifications of new activities of the given term. `ActivityReceiver.newActivities()` is invoked when a new `Activity` appears in this course catalog.
Parameters	`osid.id.Id`	`termId`	a term `Id`
Errors	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedActivities
Description	Registers for notification of updated courses. `ActivityReceiver.changedActivities()` is invoked when an activity 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	registerForChangedActivitiesForActivityUnit
Description	Register for notifications of updated activities of the given activity unit. `ActivityReceiver.changedActivities()` is invoked when an activity in this course catalog is changed.
Parameters	`osid.id.Id`	`activityUnitId`	an activity unit `Id`
Errors	NULL_ARGUMENT		`activityUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedActivitiesForCourseOffering
Description	Register for notifications of updated activities of the given course offering. `ActivityReceiver.changedActivities()` is invoked when an activity in this course catalog is changed.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedActivitiesForTerm
Description	Register for notifications of updated activities of the given term. `ActivityReceiver.changedActivities()` is invoked when an activity in this course catalog is changed.
Parameters	`osid.id.Id`	`termId`	a term `Id`
Errors	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedActivity
Description	Registers for notification of an updated activity. `ActivityReceiver.changedActivities()` is invoked when the specified activity 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	registerForDeletedActivities
Description	Registers for notification of deleted activities. `ActivityReceiver.deletedActivities()` is invoked when an activity 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	registerForDeletedActivitiesForActivityUnit
Description	Register for notifications of deleted activities of the given activity unit. `ActivityReceiver.deletedActivities()` is invoked when an activity is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`activityUnitId`	an activity unit `Id`
Errors	NULL_ARGUMENT		`activityUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedActivitiesForCourseOffering
Description	Register for notifications of deleted activities of the given course offering. `ActivityReceiver.deletedActivities()` is invoked when an activity is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedActivitiesForTerm
Description	Register for notifications of deleted activities of the given term. `ActivityReceiver.deletedActivity()` is invoked when an activity is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`termId`	a term `Id`
Errors	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedActivity
Description	Registers for notification of a deleted activity. `ActivityReceiver.deletedActivities()` is invoked when the specified activity is deleted or removed from this course catalog.
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.