OSID - osid.course.chronicle.CredentialEntryNotificationSession Service Interface Definition

Interface	osid.course.chronicle.CredentialEntryNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `CredentialEntry` objects in this `CourseCatalog.` This also includes existing courses 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 `CredentialEntryLookupSession.`
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	canRegisterForCredentialEntryNotifications
Description	Tests if this user can register for `CredentialEntry` 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 credential entries 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	reliableCredentialEntryNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeCredentialEntryNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableCredentialEntryNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeCredentialEntryNotification
Description	Acknowledge a credential entry 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	registerForNewCredentialEntries
Description	Register for notifications of new credential entries. `CredentialEntryReceiver.newCredentialEntries()` is invoked when a new `CredentialEntry` 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	registerForNewCredentialEntriesForStudent
Description	Registers for notification of new credential entries for the given student. `CredentialEntryReceiver.newCredentialEntries()` is invoked when a new credential entry appears in this course catalog.
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	registerForNewCredentialEntriesForCredential
Description	Registers for notification of new credential entries for the given credential. `CredentialEntryReceiver.newCredentialEntries()` is invoked when a new credential entry appears in this course catalog.
Parameters	`osid.id.Id`	`credentialId`	the `Id` of the `Credential` to monitor
Errors	NULL_ARGUMENT		`credentialId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCredentialEntries
Description	Registers for notification of updated credential entries. `CredentialEntryReceiver.changedCredentialEntries()` is invoked when a credential entry 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	registerForChangedCredentialEntriesForStudent
Description	Registers for notification of updated credential entries for the given student. `CredentialEntryReceiver.changedCredentialEntries()` is invoked when a credential entry is updated in this course catalog.
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	registerForChangedCredentialEntriesForCredential
Description	Registers for notification of updated credential entries for the given credential. `CredentialEntryReceiver.newCredentialEntries() is invoked` when a credential entry is updated in this course catalog.
Parameters	`osid.id.Id`	`credentialId`	the `Id` of the `Credential` to monitor
Errors	NULL_ARGUMENT		`credentialId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCredentialEntry
Description	Registers for notification of an updated credential entry. `CredentialEntryReceiver.changedCredentialEntries()` is invoked when the specified credential entry in this course catalog is changed.
Parameters	`osid.id.Id`	`credentialEntryId`	the `Id` of the `CredentialEntry` to monitor
Errors	NULL_ARGUMENT		`credentialEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCredentialEntries
Description	Registers for notification of deleted credential entries. `CredentialEntryReceiver.deletedCredentialEntries()` is invoked when a credential entry 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	registerForDeletedCredentialEntriesForStudent
Description	Registers for notification of deleted credential entries for the given student. `CredentialEntryReceiver.deletedCredentialEntries()` is invoked when a credential entry is deleted or removed from this course catalog.
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	registerForDeletedCredentialEntriesForCredential
Description	Registers for notification of deleted credential entries for the given credential. `CredentialEntryReceiver.deletedCredentialEntries()` is invoked when a credential entry is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`credentialId`	the `Id` of the `Credential` to monitor
Errors	NULL_ARGUMENT		`credentialId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCredentialEntry
Description	Registers for notification of a deleted credential entry. `CredentialEntryReceiver.deletedCredentialEntries()` is invoked when the specified credential entry is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`credentialEntryId`	the `Id` of the `CredentialEntry` to monitor
Errors	NULL_ARGUMENT		`credentialEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.