Interface EntryNotificationSession

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

This session defines methods to receive notifications on adds/changes to Entries in this Business . This also includes existing entries that may appear or disappear due to changes in the Business 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 EntryLookupSession .

  • Method Details

    • getBusinessId

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

    • getBusiness

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

    • canRegisterForEntryNotifications

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

    • useFederatedBusinessView

      void useFederatedBusinessView()
      Federates the view for methods in this session. A federated view will include entries in catalogs which are children of this catalog in the business hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedBusinessView

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

    • reliableEntryNotifications

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

    • unreliableEntryNotifications

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

    • acknowledgeEntryNotification

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

    • registerForNewEntries

      void registerForNewEntries() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new entries. EntryReceiver.newEntries() is invoked when a new Entry appears in this business.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewEntriesForCustomer

      void registerForNewEntriesForCustomer(Id customerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new entries for the given customer. EntryReceiver.newEntries() is invoked when a new Entry appears in this business.
      Parameters:
      customerId - the Id of the Customer to monitor
      Throws:
      NullArgumentException - customerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewEntriesForItem

      void registerForNewEntriesForItem(Id itemId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new entries for the given item. EntryReceiver.newEntries() is invoked when a new Entry appears in this business.
      Parameters:
      itemId - the Id of the Item to monitor
      Throws:
      NullArgumentException - itemId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedEntries

      void registerForChangedEntries() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated customers. EntryReceiver.changedEntries() is invoked when an entry in this business is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedEntriesForCustomer

      void registerForChangedEntriesForCustomer(Id customerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated entries for the given customer. EntryReceiver.changedEntries() is invoked when the specified entry in this business is changed.
      Parameters:
      customerId - the Id of the Customer to monitor
      Throws:
      NullArgumentException - customerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedEntriesForItem

      void registerForChangedEntriesForItem(Id itemId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated entries for the given item. EntryReceiver.changedEntries() is invoked when the specified entry in this business is changed.
      Parameters:
      itemId - the Id of the Item to monitor
      Throws:
      NullArgumentException - itemId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedEntry

      void registerForChangedEntry(Id entryId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated entry. EntryReceiver.changedEntry() is invoked when the specified entry in this business is changed.
      Parameters:
      entryId - the Id of the Entry to monitor
      Throws:
      NullArgumentException - entryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedEntries

      void registerForDeletedEntries() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted entries. EntryReceiver.deletedEntries() is invoked when an entry is deleted or removed from this business.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedEntriesForCustomer

      void registerForDeletedEntriesForCustomer(Id customerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted entries for the given customer. EntryReceiver.deletedEntries() is invoked when the specified entry is deleted or removed from this business.
      Parameters:
      customerId - the Id of the Customer to monitor
      Throws:
      NullArgumentException - customerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedEntriesForItem

      void registerForDeletedEntriesForItem(Id itemId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted entries for the given item. EntryReceiver.deletedEntries() is invoked when the specified entry is deleted or removed from this business.
      Parameters:
      itemId - the Id of the Item to monitor
      Throws:
      NullArgumentException - itemId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedEntry

      void registerForDeletedEntry(Id entryId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted entry. EntryReceiver.deletedEntries() is invoked when the specified entry is deleted or removed from this business.
      Parameters:
      entryId - the Id of the Entry to monitor
      Throws:
      NullArgumentException - entryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.