OSID - osid.learning.ActivityNotificationSession Service Interface Definition

Interface	osid.learning.ActivityNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.learning.LearningManager`
Used By	`osid.learning.LearningProxyManager`
Description	This session defines methods to receive asynchronous notifications on adds/changes to `Activities`. 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	getObjectiveBankId
Description	Gets the `ObjectiveBank` `Id` associated with this session.
Return	`osid.id.Id`		the `ObjectiveBank Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveBank
Description	Gets the `ObjectiveBank` associated with this session.
Return	`osid.learning.ObjectiveBank`		the `ObjectiveBank` associated with this session
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	useFederatedObjectiveBankView
Description	Federates the view for methods in this session. A federated view will include notifications for activities in objective banks which are children of this objective bank in the objective bank hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedObjectiveBankView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this objective bank 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 is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewActivitiesForObjective
Description	Register for notifications of new activities for the given objective. `ActivityReceiver.newActivities()` is invoked when a new activity is created.
Parameters	`osid.id.Id`	`objectiveId`	the `Id` of the `Activity` to monitor
Errors	NULL_ARGUMENT		`objectiveId 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 activities. `ActivityReceiver.changedActivities()` is invoked when an activity is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedActivitiesForObjective
Description	Registers for notification of updated activities. `ActivityReceiver.changedActivities()` is invoked when an activity is changed.
Parameters	`osid.id.Id`	`objectiveId`	the `Id` of the `Objective` to monitor
Errors	NULL_ARGUMENT		`objectiveId 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 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 removed from this objective bank.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedActivitiesForObjective
Description	Registers for notification of deleted activities. `ActivityReceiver.deletedActivities()` is invoked when an activity is removed from this objective bank.
Parameters	`osid.id.Id`	`objectiveId`	the `Id` of the `Objective` to monitor
Errors	NULL_ARGUMENT		`objectiveId 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.changedActivities()` is invoked when the specified activity is removed from this objective bank.
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.