Interface HoldNotificationSession

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

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

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

    • canRegisterForHoldNotifications

      boolean canRegisterForHoldNotifications()
      Tests if this user can register for Hold 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 holds 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 notifications to this oubliette only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableHoldNotifications

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

    • unreliableHoldNotifications

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

    • acknowledgeHoldNotification

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

    • registerForNewHolds

      void registerForNewHolds() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new holds. HoldReceiver.newHolds() is invoked when a new Hold appears in this oubliette.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewHoldsForResource

      void registerForNewHoldsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new holds for the given resource Id including any holds for agents related to the resource. HoldReceiver.newHolds() is invoked when a new Hold is created.
      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.

    • registerForNewHoldsForIssue

      void registerForNewHoldsForIssue(Id issueId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new holds for the given issue Id . HoldReceiver.newHolds() is invoked when a new Hold is created.
      Parameters:
      issueId - the Id of the issue to monitor
      Throws:
      NullArgumentException - issueid is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedHolds

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

    • registerForChangedHoldsForResource

      void registerForChangedHoldsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated holds for the given resource Id including any holds for agents related to the resource. HoldReceiver.changedHolds() is invoked when a Hold in this oubliette 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.

    • registerForChangedHoldsForIssue

      void registerForChangedHoldsForIssue(Id issueId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated holds for the given issue Id . HoldReceiver.changedHolds() is invoked when a Hold in this oubliette is changed.
      Parameters:
      issueId - the Id of the issue to monitor
      Throws:
      NullArgumentException - issueId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedHold

      void registerForChangedHold(Id holdId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of an updated hold. HoldReceiver.changedHolds() is invoked when the specified hold in this oubliette is changed.
      Parameters:
      holdId - the Id of the Hold to monitor
      Throws:
      NotFoundException - a hold was not found in this oubliette identified by the given Id
      NullArgumentException - holdId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedHolds

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

    • registerForDeletedHoldsForResource

      void registerForDeletedHoldsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of deleted holds for the given resource Id including any holds for agents related to the resource. HoldReceiver.deletedHolds() is invoked when a Hold is deleted or removed from this oubliette.
      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.

    • registerForDeletedHoldsForIssue

      void registerForDeletedHoldsForIssue(Id issueId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of deleted holds for the given issue Id . HoldReceiver.deletedHolds() is invoked when a Hold is deleted or removed from this oubliette.
      Parameters:
      issueId - the Id of the issue to monitor
      Throws:
      NullArgumentException - issueId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedHold

      void registerForDeletedHold(Id holdId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted hold. HoldReceiver.deletedHolds() is invoked when the specified hold is deleted or removed from this oubliette.
      Parameters:
      holdId - the Id of the Hold to monitor
      Throws:
      NotFoundException - a hold was not found identified by the given Id
      NullArgumentException - holdId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.