Interface CustomerNotificationSession

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

This session defines methods to receive notifications on adds/changes to Customers in this Business . This also includes existing customers 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 CustomerLookupSession .

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

    • canRegisterForCustomerNotifications

      boolean canRegisterForCustomerNotifications()
      Tests if this user can register for Customer 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 customers 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.

    • reliableCustomerNotifications

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

    • unreliableCustomerNotifications

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

    • acknowledgeCustomerNotification

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

    • registerForNewCustomers

      void registerForNewCustomers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new customers. CustomerReceiver.newCustomers() is invoked when a new Customer appears in this business.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewCustomersForResource

      void registerForNewCustomersForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new customers for the given resource. CustomerReceiver.newCustomers() is invoked when a new Customer appears in this business.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCustomers

      void registerForChangedCustomers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated customers. CustomerReceiver.changedCustomers() is invoked when a customer in this business is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCustomersForResource

      void registerForChangedCustomersForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated customers for the given resource. CustomerReceiver.changedCustomers() is invoked when the specified customer in this business is changed.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCustomer

      void registerForChangedCustomer(Id customerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated customer. CustomerReceiver.changedCustomers() is invoked when the specified customer 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.

    • registerForDeletedCustomers

      void registerForDeletedCustomers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted customers. CustomerReceiver.deletedCustomer() is invoked when a customer is deleted or removed from this business.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCustomersForResource

      void registerForDeletedCustomersForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted customers by the given resource. CustomerReceiver.deletedCustomers() is invoked when the specified customer is deleted or removed from this business.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCustomer

      void registerForDeletedCustomer(Id customerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted customer. CustomerReceiver.deletedCustomers() is invoked when the specified customer 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.