Interface ProcessEnablerNotificationSession

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

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

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

    • canRegisterForProcessEnablerNotifications

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

    • reliableProcessEnablerNotifications

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

    • unreliableProcessEnablerNotifications

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

    • acknowledgeProcessEnablerNotification

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

    • registerForNewProcessEnablers

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

    • registerForChangedProcessEnablers

      void registerForChangedProcessEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated office. ProcessEnablerReceiver.changedProcessEnablers() is invoked when a process enabler in this office is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProcessEnabler

      void registerForChangedProcessEnabler(Id processEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated process enabler. ProvisionableReceiver.changedProcessEnablers() is invoked when the specified process enabler in this office is changed.
      Parameters:
      processEnablerId - the Id of the ProcessEnabler to monitor
      Throws:
      NullArgumentException - processEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProcessEnablers

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

    • registerForDeletedProcessEnabler

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