Interface BidEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to BidEnablers in this AuctionHouse . This also includes existing bid enablers that may appear or disappear due to changes in the AuctionHouse h ierarchy, 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 BidEnablerLookupSession .

  • Method Details

    • getAuctionHouseId

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

    • getAuctionHouse

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

    • canRegisterForBidEnablerNotifications

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

    • useFederatedAuctionHouseView

      void useFederatedAuctionHouseView()
      Federates the view for methods in this session. A federated view will include bid enablers in auction houses which are children of this auction house in the auction house hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedAuctionHouseView

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

    • reliableBidEnablerNotifications

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

    • unreliableBidEnablerNotifications

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

    • acknowledgeBidEnablerNotification

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

    • registerForNewBidEnablers

      void registerForNewBidEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new bid enablers. BidEnablerReceiver.newBidEnablers() is invoked when a new BidEnabler appears in this auction house.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedBidEnablers

      void registerForChangedBidEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated bid enablers. BidEnablerReceiver.changedBidEnablers() is invoked when a BidEnabler in this auction house is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedBidEnabler

      void registerForChangedBidEnabler(Id bidEnablerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated bid enabler. BidEnablerReceiver.changedBidEnablers() is invoked when the specified BidEnabler in this auction house is changed.
      Parameters:
      bidEnablerId - the Id of the BidEnabler to monitor
      Throws:
      NullArgumentException - bidEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedBidEnablers

      void registerForDeletedBidEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted bid enablers. BidEnablerReceiver.deletedBidEnablers() is invoked when a bid enabler is deleted or removed from this auction house.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedBidEnabler

      void registerForDeletedBidEnabler(Id bidEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted bid enabler. BidEnablerReceiver.deletedBidEnabler() is invoked when the specified bid enabler is deleted or removed from this auction house.
      Parameters:
      bidEnablerId - the Id of the BidEnabler to monitor
      Throws:
      NullArgumentException - bidEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.