Interface RegistrationRequestNotificationSession

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

This session defines methods to receive notifications on adds/changes to RegistrationRe quests in this CourseCatalog . This also includes existing registration requests 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 RegistrationRequestLookupSess ion.

  • 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.

    • canRegisterForRegistrationRequestNotifications

      boolean canRegisterForRegistrationRequestNotifications()
      Tests if this user can register for RegistrationR equest 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 registration requests in course catalogs which are children of this course 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.

    • reliableRegistrationRequestNotifications

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

    • unreliableRegistrationRequestNotifications

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

    • acknowledgeRegistrationRequestNotification

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

    • registerForNewRegistrationRequests

      void registerForNewRegistrationRequests() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new registration requests. RegistrationRequestReceiver.newRegistrationRequests() is invoked when a new RegistrationRequest appears in this course catalog.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewRegistrationRequestsForRequester

      void registerForNewRegistrationRequestsForRequester(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new registration requests for the given requester. RegistrationRequestReceiver.newRegistrationRequests() is invoked when a new RegistrationRequest appears in this course catalog.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewRegistrationRequestsForTerm

      void registerForNewRegistrationRequestsForTerm(Id termId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new registration requests for the given term. RegistrationRequestReceiver.newRegistrationRequests() is invoked when a new RegistrationRequest appears in this course catalog.
      Parameters:
      termId - the Id of the Term to monitor
      Throws:
      NullArgumentException - termId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRegistrationRequests

      void registerForChangedRegistrationRequests() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated registration requests. RegistrationRequestReceiver.changedRegistrationRequests() is invoked when a RegistrationRequest in this course catalog is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRegistrationRequestsForRequester

      void registerForChangedRegistrationRequestsForRequester(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated registration requests for the given requester. RegistrationRequestReceiver.changedRegistrationRequests() is invoked when a RegistrationRequest in this course catalog is changed.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRegistrationRequestsForTerm

      void registerForChangedRegistrationRequestsForTerm(Id termId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated registration requests for the given term. RegistrationRequestReceiver.changedRegistrationRequests() is invoked when a RegistrationRequest in this course catalog is changed.
      Parameters:
      termId - the Id of the Term to monitor
      Throws:
      NullArgumentException - termId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRegistrationRequest

      void registerForChangedRegistrationRequest(Id registrationRequestId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated registration request. RegistrationRequestReceiver.changedRegistrationRequests() is invoked when the specified RegistrationRequest in this course catalog is changed.
      Parameters:
      registrationRequestId - the Id of the RegistrationRequest to monitor
      Throws:
      NullArgumentException - registrationRequestId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedRegistrationRequests

      void registerForDeletedRegistrationRequests() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted registration requests. RegistrationRequestReceiver.deletedRegistrationRequests() is invoked when a registration request is deleted or removed from this course catalog.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedRegistrationRequestsForRequester

      void registerForDeletedRegistrationRequestsForRequester(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted registration requests for the given requester. RegistrationRequestReceiver.deletedRegistrationRequests() is invoked when a registration request is deleted or removed from this course catalog.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedRegistrationRequestsForTerm

      void registerForDeletedRegistrationRequestsForTerm(Id termId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted registration requests for the given term. RegistrationRequestReceiver.deletedRegistrationRequests() is invoked when a registration request is deleted or removed from this course catalog.
      Parameters:
      termId - the Id of the Term to monitor
      Throws:
      NullArgumentException - termId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedRegistrationRequest

      void registerForDeletedRegistrationRequest(Id registrationRequestId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted registration request. RegistrationRequestReceiver.deletedRegistrationRequests() is invoked when the specified registration request is deleted or removed from this course catalog.
      Parameters:
      registrationRequestId - the Id of the RegistrationRequest to monitor
      Throws:
      NullArgumentException - registrationRequestId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.