Interface RegistrationRequestItemNotificationSession

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

This session defines methods to receive notifications on adds/changes to RegistrationRe questItems in this CourseCatalog . This also includes existing registration request items 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 RegistrationRequestItemLookup Session.

  • 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

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

    • canRegisterForRegistrationRequestItemNotifications

      boolean canRegisterForRegistrationRequestItemNotifications()
      Tests if this user can register for RegistrationR equestItem 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 request items 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.

    • reliableRegistrationRequestItemNotifications

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

    • unreliableRegistrationRequestItemNotifications

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

    • acknowledgeRegistrationRequestItemNotification

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

    • registerForNewRegistrationRequestItems

      void registerForNewRegistrationRequestItems() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new registration request items. RegistrationRequestItemReceiver.newRegistrationRequestItems() is invoked when a new RegistrationRequestItem appears in this course catalog.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewRegistrationRequestItemsForRegistrationRequest

      void registerForNewRegistrationRequestItemsForRegistrationRequest(Id registrationRequestId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new registration request items for the given registration request. RegistrationRequestItemReceiver.newRegistrationRequestItems() is invoked when a new RegistrationRequestItem appears in 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.

    • registerForChangedRegistrationRequestItems

      void registerForChangedRegistrationRequestItems() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated registration request items. RegistrationRequestItemReceiver.changedRegistrationRequestItems() is invoked when a RegistrationRequestItem in this course catalog is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRegistrationRequestItemsForRegistrationRequest

      void registerForChangedRegistrationRequestItemsForRegistrationRequest(Id registrationRequestId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated registration request items for thegiven registration request. RegistrationRequestItemReceiver.changedRegistrationRequestItems() is invoked when a RegistrationRequestItem 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.

    • registerForChangedRegistrationRequestItem

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

    • registerForDeletedRegistrationRequestItems

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

    • registerForDeletedRegistrationRequestItemsForRegistrationRequest

      void registerForDeletedRegistrationRequestItemsForRegistrationRequest(Id registrationRequestId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted registration request items for the given registration request. RegistrationRequestItemReceiver.deletedRegistrationRequestItems() is invoked when a registration request item 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.

    • registerForDeletedRegistrationRequestItem

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