Interface ProgramOfferingNotificationSession

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

This session defines methods to receive notifications on adds/changes to ProgramOfferings in this CourseCatalog . This also includes existing program offerings 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 ProgramOfferingLookupSession .

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

    • canRegisterForProgramOfferingNotifications

      boolean canRegisterForProgramOfferingNotifications()
      Tests if this user can register for ProgramOffering 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 program offerings 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.

    • reliableProgramOfferingNotifications

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

    • unreliableProgramOfferingNotifications

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

    • acknowledgeProgramOfferingNotification

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

    • registerForNewProgramOfferings

      void registerForNewProgramOfferings() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new program offerings. ProgramOfferingReceiver.newProgramOfferings() is invoked when a new ProgramOffering appears in this course catalog.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewProgramOfferingsForProgram

      void registerForNewProgramOfferingsForProgram(Id programId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of new program offerings for a program. ProgramOfferingReceiver.newProgramOfferings() is invoked when the specified program offering appears in this course catalog.
      Parameters:
      programId - the Id of the Program to monitor
      Throws:
      NullArgumentException - programId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewProgramOfferingsForTerm

      void registerForNewProgramOfferingsForTerm(Id termId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of new program offerings for a term. ProgramOfferingReceiver.newProgramOfferings() is invoked when the specified program offering 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.

    • registerForChangedProgramOfferings

      void registerForChangedProgramOfferings() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated programs. ProgramOfferingReceiver.changedProgramOfferings() is invoked when a program offering in this course catalog is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProgramOfferingsForProgram

      void registerForChangedProgramOfferingsForProgram(Id programId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated program offerings for a program. ProgramOfferingReceiver.changedProgramOfferings() is invoked when a program offering in this course catalog is changed.
      Parameters:
      programId - the Id of the Program to monitor
      Throws:
      NullArgumentException - programId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProgramOfferingsForTerm

      void registerForChangedProgramOfferingsForTerm(Id termId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated program offerings for a term. ProgramOfferingReceiver.changedProgramOfferings() is invoked when a program offering 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.

    • registerForChangedProgramOffering

      void registerForChangedProgramOffering(Id programOfferingId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated program offering. ProgramOfferingReceiver.changedProgramOffering() is invoked when the specified program offering in this course catalog is changed.
      Parameters:
      programOfferingId - the Id of the ProgramOffering to monitor
      Throws:
      NullArgumentException - programOfferingId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProgramOfferings

      void registerForDeletedProgramOfferings() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted programs. ProgramOfferingReceiver.deletedProgramOfferings() is invoked when a program offering is deleted or removed from this course catalog.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProgramOfferingsForProgram

      void registerForDeletedProgramOfferingsForProgram(Id programId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted program offerings for a program. ProgramOfferingReceiver.deletedProgramOfferings() is invoked when a program offering in this course catalog is removed.
      Parameters:
      programId - the Id of the Program to monitor
      Throws:
      NullArgumentException - programId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProgramOfferingsForTerm

      void registerForDeletedProgramOfferingsForTerm(Id termId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated program offerings for a term. ProgramOfferingReceiver.deletedProgramOfferings() is invoked when a program offering in this course catalog is removed.
      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.

    • registerForDeletedProgramOffering

      void registerForDeletedProgramOffering(Id programOfferingId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted program offering. ProgramOfferingReceiver.deletedProgramOfferings() is invoked when the specified program offering is deleted or removed from this course catalog.
      Parameters:
      programOfferingId - the Id of the ProgramOffering to monitor
      Throws:
      NullArgumentException - programOfferingId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.