Interface AuctionConstrainerEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to AuctionConstrainerEnabler objects in this AuctionHouse . This also includes existing AuctionConstrainerEnablers 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 AuctionConstrainerEnablerLookupSession .

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

    • canRegisterForAuctionConstrainerEnablerNotifications

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

    • reliableAuctionConstrainerEnablerNotifications

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

    • unreliableAuctionConstrainerEnablerNotifications

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

    • acknowledgeAuctionConstrainerEnablerNotification

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

    • registerForNewAuctionConstrainerEnablers

      void registerForNewAuctionConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new auction constrainer enablers. AuctionConstrainerEnablerReceiver.newAuctionConstrainerEnablers() is invoked when a new AuctionConstrainerEnabler appears in this auction house.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAuctionConstrainerEnablers

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

    • registerForChangedAuctionConstrainerEnabler

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

    • registerForDeletedAuctionConstrainerEnablers

      void registerForDeletedAuctionConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted auction constrainer enablers. AuctionConstrainerEnablerReceiver.deletedAuctionConstrainerEnablers() is invoked when an auction constrainer 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.

    • registerForDeletedAuctionConstrainerEnabler

      void registerForDeletedAuctionConstrainerEnabler(Id auctionConstrainerEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted auction constrainer enabler. AuctionConstrainerEnablerReceiver.deletedAuctionConstrainerEnablers() is invoked when the specified auction constrainer enabler is deleted or removed from this auction house.
      Parameters:
      auctionConstrainerEnablerId - the Id of the AuctionConstrainerEnabler to monitor
      Throws:
      NullArgumentException - auctionConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.