Interface CommissionEnablerNotificationSession

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

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

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

    • canRegisterForCommissionEnablerNotifications

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

    • reliableCommissionEnablerNotifications

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

    • unreliableCommissionEnablerNotifications

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

    • acknowledgeCommissionEnablerNotification

      void acknowledgeCommissionEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a commission 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.

    • registerForNewCommissionEnablers

      void registerForNewCommissionEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new commission enablers. CommissionEnablerReceiver.newCommissionEnablers() is invoked when a new CommissionEnabler appears in this foundry.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCommissionEnablers

      void registerForChangedCommissionEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated foundries. CommissionEnablerReceiver.changedCommissionEnablers() is invoked when a commission enabler in this foundry is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCommissionEnabler

      void registerForChangedCommissionEnabler(Id commissionEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated commission enabler. ProvisionableReceiver.changedCommissionEnablers() is invoked when the specified commission enabler in this foundry is changed.
      Parameters:
      commissionEnablerId - the Id of the CommissionEnabler to monitor
      Throws:
      NullArgumentException - commissionEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCommissionEnablers

      void registerForDeletedCommissionEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted commission enablers. CommissionEnablerReceiver.deletedCommissionEnablers() is invoked when a commission enabler is deleted or removed from this foundry.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCommissionEnabler

      void registerForDeletedCommissionEnabler(Id commissionEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted commission enabler. CommissionEnablerReceiver.deletedCommissionEnablers() is invoked when the specified commission enabler is deleted or removed from this foundry.
      Parameters:
      commissionEnablerId - the Id of the CommissionEnabler to monitor
      Throws:
      NullArgumentException - commissionEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.