Interface ProcessConstrainerNotificationSession

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

This session defines methods to receive notifications on adds/changes to ProcessConstrainers in this Office . This also includes existing process constrainers 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 ProcessConstrainerLookupSession .

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

    • canRegisterForProcessConstrainerNotifications

      boolean canRegisterForProcessConstrainerNotifications()
      Tests if this user can register for ProcessConstrainer 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 constrainers 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.

    • reliableProcessConstrainerNotifications

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

    • unreliableProcessConstrainerNotifications

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

    • acknowledgeProcessConstrainerNotification

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

    • registerForNewProcessConstrainers

      void registerForNewProcessConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new process constrainers. ProcessConstrainerReceiver.newProcessConstrainers() is invoked when a new ProcessConstrainer appears in this office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProcessConstrainers

      void registerForChangedProcessConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated process constrainers. ProcessConstrainerReceiver.changedProcessConstrainers() is invoked when a ProcessConstrainer in this office is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProcessConstrainer

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

    • registerForDeletedProcessConstrainers

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

    • registerForDeletedProcessConstrainer

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