Interface CredentialNotificationSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface CredentialNotificationSession extends OsidSession

This session defines methods to receive notifications on adds/changes to Credentials 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 CredentialLookupSession .

  • Method Details

    • getCourseCatalogId

      Id getCourseCatalogId()
      Gets the CourseCatalog Id associated with this session.
      Returns:
      the CourseCatalog Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalog

      CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
      Gets the CourseCatalog associated with this session.
      Returns:
      the course catalog
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForCredentialNotifications

      boolean canRegisterForCredentialNotifications()
      Tests if this user can register for Credential 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.
      Returns:
      false if notification methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedCourseCatalogView

      void useFederatedCourseCatalogView()
      Federates the view for methods in this session. A federated view will include credentials in catalogs which are children of this catalog in the course catalog hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCourseCatalogView

      void useIsolatedCourseCatalogView()
      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.

    • reliableCredentialNotifications

      void reliableCredentialNotifications()
      Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeCrededntialNotification() .
      Compliance:
      mandatory - This method is must be implemented.

    • unreliableCredentialNotifications

      void unreliableCredentialNotifications()
      Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
      Compliance:
      mandatory - This method is must be implemented.

    • acknowledgeCredentialNotification

      void acknowledgeCredentialNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a credential notification.
      Parameters:
      notificationId - the Id of the notification
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewCredentials

      void registerForNewCredentials() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new credentials. CredentialReceiver.newCredentials() is invoked when a new Credential appears in this course catalog.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCredentials

      void registerForChangedCredentials() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated credentials. CredentialReceiver.changedCredentials() is invoked when a credential in this course catalog is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCredential

      void registerForChangedCredential(Id credentialId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated credential. CredentialReceiver.changedCredentials() is invoked when the specified credential in this course catalog is changed.
      Parameters:
      credentialId - the Id of the Credential to monitor
      Throws:
      NullArgumentException - credentialId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCredentials

      void registerForDeletedCredentials() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted credentials. CredentialReceiver.deletedCredentials() is invoked when a credential is deleted or removed from this course catalog.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCredential

      void registerForDeletedCredential(Id credentialId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted credential. CredentialReceiver.deletedCredentials() is invoked when the specified credential is deleted or removed from this course catalog.
      Parameters:
      credentialId - the Id of the Credential to monitor
      Throws:
      NullArgumentException - credentialId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.