Interface HoldEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to HoldEnabler objects in this Hold . This also includes existing HoldEnablers that may appear or disappear due to changes in the Hold 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 HoldEnablerLookupSession .

  • Method Details

    • getOublietteId

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

    • getOubliette

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

    • canRegisterForHoldEnablerNotifications

      boolean canRegisterForHoldEnablerNotifications()
      Tests if this user can register for HoldEnabler 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.

    • useFederatedOublietteView

      void useFederatedOublietteView()
      Federates the view for methods in this session. A federated view will include hold enablers in oubliettes which are children of this oubliette in the oubliette hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedOublietteView

      void useIsolatedOublietteView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this oubliette only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableHoldEnablerNotifications

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

    • unreliableHoldEnablerNotifications

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

    • acknowledgeHoldEnablerNotification

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

    • registerForNewHoldEnablers

      void registerForNewHoldEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new hold enablers. HoldEnablerReceiver.newHoldEnablers() is invoked when a new HoldEnabler appears in this oubliette.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedHoldEnablers

      void registerForChangedHoldEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated hold enablers. HoldEnablerReceiver.changedHoldEnablers() is invoked when a hold enabler in this oubliette is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedHoldEnabler

      void registerForChangedHoldEnabler(Id holdEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated hold enabler. ProvisionableReceiver.changedHoldEnablers() is invoked when the specified hold enabler in this oubliette is changed.
      Parameters:
      holdEnablerId - the Id of the HoldEnabler to monitor
      Throws:
      NullArgumentException - holdEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedHoldEnablers

      void registerForDeletedHoldEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted hold enablers. HoldEnablerReceiver.deletedHoldEnablers() is invoked when a hold enabler is deleted or removed from this oubliette.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedHoldEnabler

      void registerForDeletedHoldEnabler(Id holdEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted hold enabler. HoldEnablerReceiver.deletedHoldEnablers() is invoked when the specified hold enabler is deleted or removed from this oubliette.
      Parameters:
      holdEnablerId - the Id of the HoldEnabler to monitor
      Throws:
      NullArgumentException - holdEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.