OSID - osid.learning.ProficiencyNotificationSession Service Interface Definition

Interface	osid.learning.ProficiencyNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Proficiency` objects in this `ObjectiveBank.` This also includes existing proficiencies that may appear or disappear due to changes in the `ObjectiveBank` 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 `ProficiencyLookupSession.`
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 obective bank
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForProficiencyNotifications
Description	Tests if this user can register for `Proficiency` 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 proficiencies in objective banks which are children of this objective bank in the obective 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	reliableProficiencyNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeProficiencyNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableProficiencyNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeProficiencyNotification
Description	Acknowledge a proficiency 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	registerForNewProficiencies
Description	Register for notifications of new proficiencies. `ProficiencyReceiver.newProficiencies()` is invoked when a new `Proficiency` appears in this objective bank.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewProficienciesByGenusType
Description	Register for notifications of new proficiencies with the given genus type. `ProficiencyReceiver.newProficiencies()` is invoked when a new `Proficiency` appears for the given resource in this objective bank.
Parameters	`osid.type.Type`	`proficiencyGenusType`	the genus type of a proficiency to monitor
Errors	NULL_ARGUMENT		`proficiencyGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewProficienciesForObjective
Description	Register for notifications of new proficiencies. `ProficiencyReceiver.newProficiencies()` is invoked when a new `Proficiency` appears for the given objective in this objective bank.
Parameters	`osid.id.Id`	`objectiveId`	the `Id` of a resource 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	registerForNewProficienciesForResource
Description	Register for notifications of new proficiencies. `ProficiencyReceiver.newProficiencies()` is invoked when a new `Proficiency` appears for the given resource in this objective bank.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of a resource to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProficiencies
Description	Registers for notification of updated proficiencies. `ProficiencyReceiver.changedProficiencies()` is invoked when a proficiency in this objective bank is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProficienciesByGenusType
Description	Registers for notification of updated proficiencies of the given genus type. `ProficiencyReceiver.changedProficiencies()` is invoked when a proficiency in this objective bank is changed.
Parameters	`osid.type.Type`	`proficiencyGenusType`	the genus type of the `Proficiency` to monitor
Errors	NULL_ARGUMENT		`proficiencyGenusTYpe` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProficienciesForObjective
Description	Registers for notification of an updated proficiency. `ProficiencyReceiver.changedProficiencies()` is invoked when the specified proficiency related to the given objective is changed in 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	registerForChangedProficienciesForResource
Description	Registers for notification of an updated proficiency. `ProficiencyReceiver.changedProficiencies()` is invoked when the specified proficiency related to the given resource is changed in this objective bank.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProficiency
Description	Registers for notification of an updated proficiency. `ProficiencyReceiver.changedProficiencies()` is invoked when the specified proficiency in this objective bank is changed.
Parameters	`osid.id.Id`	`proficiencyId`	the `Id` of the `Proficiency` to monitor
Errors	NULL_ARGUMENT		`proficiencyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProficiencies
Description	Registers for notification of deleted proficiencies. `ProficiencyReceiver.deletedProficiencies()` is invoked when a proficiency is deleted or 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	registerForDeletedProficienciesByGenusType
Description	Registers for notification of deleted proficiencies of the given genus type. `ProficiencyReceiver.deletedProficiencies()` is invoked when a proficiency is deleted or removed from this objective bank.
Parameters	`osid.type.Type`	`proficiencyGenusType`	the genus type of the `Proficiency` to monitor
Errors	NULL_ARGUMENT		`proficiencyGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProficienciesForObjective
Description	Registers for notification of a deleted proficiency. `ProficiencyReceiver.deletedProficiencies()` is invoked when the specified proficiency related to the objective is deleted or 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	registerForDeletedProficienciesForResource
Description	Registers for notification of a deleted proficiency. `ProficiencyReceiver.deletedProficiencies()` is invoked when the specified proficiency related to the resource is deleted or removed from this objective bank.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProficiency
Description	Registers for notification of a deleted proficiency. `ProficiencyReceiver.deletedProficiencies()` is invoked when the specified proficiency is deleted or removed from this objective bank.
Parameters	`osid.id.Id`	`proficiencyId`	the `Id` of the `Proficiency` to monitor
Errors	NULL_ARGUMENT		`proficiencyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.