Interface AuctionProcessorEnablerNotificationSession

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

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

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

    • canRegisterForAuctionProcessorEnablerNotifications

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

    • reliableAuctionProcessorEnablerNotifications

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

    • unreliableAuctionProcessorEnablerNotifications

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

    • acknowledgeAuctionProcessorEnablerNotification

      void acknowledgeAuctionProcessorEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge an auction processor 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.

    • registerForNewAuctionProcessorEnablers

      void registerForNewAuctionProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new auction processor enablers. AuctionProcessorEnablerReceiver.newAuctionProcessorEnablers() is invoked when a new AuctionProcessorEnabler appears in this auction house.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAuctionProcessorEnablers

      void registerForChangedAuctionProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated auction house enablers. AuctionProcessorEnablerReceiver.changedAuctionProcessorEnablers() is invoked when an auction processor enabler in this auction house is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAuctionProcessorEnabler

      void registerForChangedAuctionProcessorEnabler(Id auctionProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated auction processor enabler. ProvisionableReceiver.changedAuctionProcessorEnablers() is invoked when the specified auction processor enabler in this auction house is changed.
      Parameters:
      auctionProcessorEnablerId - the Id of the AuctionProcessorEnabler to monitor
      Throws:
      NullArgumentException - auctionProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAuctionProcessorEnablers

      void registerForDeletedAuctionProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted auction processor enablers. AuctionProcessorEnablerReceiver.deletedAuctionProcessorEnablers() is invoked when an auction processor 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.

    • registerForDeletedAuctionProcessorEnabler

      void registerForDeletedAuctionProcessorEnabler(Id auctionProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted auction processor enabler. AuctionProcessorEnablerReceiver.deletedAuctionProcessorEnablers() is invoked when the specified auction processor enabler is deleted or removed from this auction house.
      Parameters:
      auctionProcessorEnablerId - the Id of the AuctionProcessorEnabler to monitor
      Throws:
      NullArgumentException - auctionProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.