public interface CredentialEntryNotificationSession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeCredentialEntryNotification(Id notificationId)
Acknowledge a credential entry notification.
|
boolean |
canRegisterForCredentialEntryNotifications()
Tests if this user can register for
CredentialEntry
notifications. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
void |
registerForChangedCredentialEntries()
Registers for notification of updated credential entries.
|
void |
registerForChangedCredentialEntriesForCredential(Id credentialId)
Registers for notification of updated credential entries for the given
credential.
|
void |
registerForChangedCredentialEntriesForStudent(Id resourceId)
Registers for notification of updated credential entries for the given
student.
|
void |
registerForChangedCredentialEntry(Id credentialEntryId)
Registers for notification of an updated credential entry.
|
void |
registerForDeletedCredentialEntries()
Registers for notification of deleted credential entries.
|
void |
registerForDeletedCredentialEntriesForCredential(Id credentialId)
Registers for notification of deleted credential entries for the given
credential.
|
void |
registerForDeletedCredentialEntriesForStudent(Id resourceId)
Registers for notification of deleted credential entries for the given
student.
|
void |
registerForDeletedCredentialEntry(Id credentialEntryId)
Registers for notification of a deleted credential entry.
|
void |
registerForNewCredentialEntries()
Register for notifications of new credential entries.
|
void |
registerForNewCredentialEntriesForCredential(Id credentialId)
Registers for notification of new credential entries for the given
credential.
|
void |
registerForNewCredentialEntriesForStudent(Id resourceId)
Registers for notification of new credential entries for the given
student.
|
void |
reliableCredentialEntryNotifications()
Reliable notifications are desired.
|
void |
unreliableCredentialEntryNotifications()
Unreliable notifications are desired.
|
void |
useFederatedCourseCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCourseCatalogView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCourseCatalogId()
CourseCatalog
Id
associated
with this session. CourseCatalog Id
associated with this
sessionmandatory
- This method must be implemented. CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
CourseCatalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForCredentialEntryNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedCourseCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCourseCatalogView()
mandatory
- This method is must be implemented. void reliableCredentialEntryNotifications()
acknowledgeCredentialEntryNotification()
.mandatory
- This method is must be implemented. void unreliableCredentialEntryNotifications()
mandatory
- This method is must be implemented. void acknowledgeCredentialEntryNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCredentialEntries() throws OperationFailedException, PermissionDeniedException
CredentialEntryReceiver.newCredentialEntries()
is invoked when
a new CredentialEntry
appears in this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCredentialEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
CredentialEntryReceiver.newCredentialEntries()
is invoked when a new credential entry appears in this course catalog.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCredentialEntriesForCredential(Id credentialId) throws OperationFailedException, PermissionDeniedException
CredentialEntryReceiver.newCredentialEntries()
is invoked when a new credential entry appears in this course
catalog.credentialId
- the Id
of the Credential
to monitorNullArgumentException
- credentialId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCredentialEntries() throws OperationFailedException, PermissionDeniedException
CredentialEntryReceiver.changedCredentialEntries()
is invoked
when a credential entry in this course catalog is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCredentialEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
CredentialEntryReceiver.changedCredentialEntries()
is invoked when a credential entry is updated in this course
catalog.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCredentialEntriesForCredential(Id credentialId) throws OperationFailedException, PermissionDeniedException
CredentialEntryReceiver.newCredentialEntries() is
invoked
when a credential entry is updated in this course
catalog.credentialId
- the Id
of the Credential
to monitorNullArgumentException
- credentialId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCredentialEntry(Id credentialEntryId) throws OperationFailedException, PermissionDeniedException
CredentialEntryReceiver.changedCredentialEntries()
is invoked
when the specified credential entry in this course catalog is changed.credentialEntryId
- the Id
of the
CredentialEntry
to monitorNullArgumentException
- credentialEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCredentialEntries() throws OperationFailedException, PermissionDeniedException
CredentialEntryReceiver.deletedCredentialEntries()
is invoked
when a credential entry is deleted or removed from this course
catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCredentialEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
CredentialEntryReceiver.deletedCredentialEntries()
is invoked when a credential entry is deleted or removed from
this course catalog.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCredentialEntriesForCredential(Id credentialId) throws OperationFailedException, PermissionDeniedException
CredentialEntryReceiver.deletedCredentialEntries()
is invoked when a credential entry is deleted or removed from
this course catalog.credentialId
- the Id
of the Credential
to monitorNullArgumentException
- credentialId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCredentialEntry(Id credentialEntryId) throws OperationFailedException, PermissionDeniedException
CredentialEntryReceiver.deletedCredentialEntries()
is invoked
when the specified credential entry is deleted or removed from this
course catalog.credentialEntryId
- the Id
of the
CredentialEntry
to monitorNullArgumentException
- credentialEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.