OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.CredentialEntryNotificationSession
Implementsosid.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.

MethodgetCourseCatalogId
Description

Gets the CourseCatalog Id associated with this session.

Returnosid.id.Idthe CourseCatalog Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalog
Description

Gets the CourseCatalog associated with this session.

Returnosid.course.CourseCatalogthe course catalog
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForCredentialEntryNotifications
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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedCourseCatalogView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCourseCatalogView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this course catalog only.

CompliancemandatoryThis method is must be implemented.
MethodreliableCredentialEntryNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeCredentialEntryNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableCredentialEntryNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeCredentialEntryNotification
Description

Acknowledge a credential entry notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCredentialEntries
Description

Register for notifications of new credential entries. CredentialEntryReceiver.newCredentialEntries() is invoked when a new CredentialEntry appears in this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCredentialEntriesForStudent
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.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCredentialEntriesForCredential
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.

Parametersosid.id.IdcredentialIdthe Id of the Credential to monitor
ErrorsNULL_ARGUMENT credentialId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCredentialEntries
Description

Registers for notification of updated credential entries. CredentialEntryReceiver.changedCredentialEntries() is invoked when a credential entry in this course catalog is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCredentialEntriesForStudent
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.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCredentialEntriesForCredential
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.

Parametersosid.id.IdcredentialIdthe Id of the Credential to monitor
ErrorsNULL_ARGUMENT credentialId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCredentialEntry
Description

Registers for notification of an updated credential entry. CredentialEntryReceiver.changedCredentialEntries() is invoked when the specified credential entry in this course catalog is changed.

Parametersosid.id.IdcredentialEntryIdthe Id of the CredentialEntry to monitor
ErrorsNULL_ARGUMENT credentialEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCredentialEntries
Description

Registers for notification of deleted credential entries. CredentialEntryReceiver.deletedCredentialEntries() is invoked when a credential entry is deleted or removed from this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCredentialEntriesForStudent
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.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCredentialEntriesForCredential
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.

Parametersosid.id.IdcredentialIdthe Id of the Credential to monitor
ErrorsNULL_ARGUMENT credentialId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCredentialEntry
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.

Parametersosid.id.IdcredentialEntryIdthe Id of the CredentialEntry to monitor
ErrorsNULL_ARGUMENT credentialEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.