Interface ProcessConstrainerEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to ProcessConstrainerEnablers in this Office . This also includes existing process constrainer enablers that may appear or disappear due to changes in the Office hierarc hy, 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 ProcessConstrainerEnablerLookupSession .

  • Method Details

    • getOfficeId

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

    • getOffice

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

    • canRegisterForProcessConstrainerEnablerNotifications

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

    • useFederatedOfficeView

      void useFederatedOfficeView()
      Federates the view for methods in this session. A federated view will include process constrainer enablers in offices which are children of this office in the office hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedOfficeView

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

    • reliableProcessConstrainerEnablerNotifications

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

    • unreliableProcessConstrainerEnablerNotifications

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

    • acknowledgeProcessConstrainerEnablerNotification

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

    • registerForNewProcessConstrainerEnablers

      void registerForNewProcessConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new process constrainer enablers. ProcessConstrainerEnablerReceiver.newProcessConstrainerEnablers() is invoked when a new ProcessConstrainerEnabler appears in this office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProcessConstrainerEnablers

      void registerForChangedProcessConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated process constrainer enablers. ProcessConstrainerEnablerReceiver.changedProcessConstrainerEnablers() is invoked when a ProcessConstrainerEnabler in this office is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProcessConstrainerEnabler

      void registerForChangedProcessConstrainerEnabler(Id processConstrainerEnablerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated process constrainer enabler. ProcessConstrainerEnablerReceiver.changedProcessConstrainerEnablers() is invoked when the specified ProcessConstrainerEnabler in this office is changed.
      Parameters:
      processConstrainerEnablerId - the Id of the ProcessConstrainerEnabler to monitor
      Throws:
      NullArgumentException - processConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProcessConstrainerEnablers

      void registerForDeletedProcessConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted process constrainer enablers. ProcessConstrainerEnablerReceiver.deletedProcessConstrainerEnablers() is invoked when a process constrainer enabler is deleted or removed from this office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProcessConstrainerEnabler

      void registerForDeletedProcessConstrainerEnabler(Id processConstrainerEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted process constrainer enabler. ProcessConstrainerEnablerReceiver.deletedProcessConstrainerEnabler() is invoked when the specified process constrainer enabler is deleted or removed from this office.
      Parameters:
      processConstrainerEnablerId - the Id of the ProcessConstrainerEnabler to monitor
      Throws:
      NullArgumentException - processConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.