Interface AvailabilityNotificationSession

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

This session defines methods to receive notifications on adds/changes to Availability objects in this Foundry . 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 AvailabilityLookupSession .

  • Method Details

    • getFoundryId

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

    • getFoundry

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

    • canRegisterForAvailabilityNotifications

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

    • useFederatedFoundryView

      void useFederatedFoundryView()
      Federates the view for methods in this session. A federated view will include availabilities in foundries which are children of this foundry in the foundry hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedFoundryView

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

    • reliableAvailabilityNotifications

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

    • unreliableAvailabilityNotifications

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

    • acknowledgeAvailabilityNotification

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

    • registerForNewAvailabilities

      void registerForNewAvailabilities() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new availabilities. AvailabilityReceiver.newAvailabilities() is invoked when a new Availability appears in this foundry.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewAvailabilitiesForResource

      void registerForNewAvailabilitiesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new availabilities for the given resource. AvailabilityReceiver.newAvailabilities() is invoked when a new Availability appears in this foundry.
      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.

    • registerForNewAvailabilitiesForJob

      void registerForNewAvailabilitiesForJob(Id jobId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new availabilities for the given job. AvailabilityReceiver.newAvailabilities() is invoked when a new Availability appears in this foundry.
      Parameters:
      jobId - the Id of the job to monitor
      Throws:
      NullArgumentException - jobId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAvailabilities

      void registerForChangedAvailabilities() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated availabilities. AvailabilityReceiver.changedAvailabilities() is invoked when an availability in this foundry is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAvailabilitiesForResource

      void registerForChangedAvailabilitiesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated availabilities for the given resource. AvailabilityReceiver.changedAvailabilities() is invoked when an availability in this foundry 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.

    • registerForChangedAvailabilitiesForJob

      void registerForChangedAvailabilitiesForJob(Id jobId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated availabilities for the given job. AvailabilityReceiver.changedAvailability() is invoked when an availability in this foundry is changed.
      Parameters:
      jobId - the Id of the job to monitor
      Throws:
      NullArgumentException - jobId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAvailability

      void registerForChangedAvailability(Id availabilityId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated availability. AvailabilityReceiver.changedAvailabilities() is invoked when the specified availability in this foundry is changed.
      Parameters:
      availabilityId - the Id of the Availability to monitor
      Throws:
      NullArgumentException - availabilityId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAvailabilities

      void registerForDeletedAvailabilities() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted availabilities. AvailabilityReceiver.deletedAvailabilities() is invoked when an availability is deleted or removed from this foundry.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAvailabilitiesForResource

      void registerForDeletedAvailabilitiesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted availabilities for the given resource. AvailabilityReceiver.deletedAvailabilities() is invoked when an availability is deleted or removed from this foundry.
      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.

    • registerForDeletedAvailabilitiesForJob

      void registerForDeletedAvailabilitiesForJob(Id jobId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted availabilities for the given job. AvailabilityReceiver.deletedAvailabilities() is invoked when an availability is deleted or removed from this foundry.
      Parameters:
      jobId - the Id of the job to monitor
      Throws:
      NullArgumentException - jobId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAvailability

      void registerForDeletedAvailability(Id availabilityId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted availability. AvailabilityReceiver.deletedAvailabilities() is invoked when the specified availability is deleted or removed from this foundry.
      Parameters:
      availabilityId - the Id of the Availability to monitor
      Throws:
      NullArgumentException - availabilityId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.