Interface AuctionConstrainerNotificationSession

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

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

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

    • canRegisterForAuctionConstrainerNotifications

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

    • reliableAuctionConstrainerNotifications

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

    • unreliableAuctionConstrainerNotifications

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

    • acknowledgeAuctionConstrainerNotification

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

    • registerForNewAuctionConstrainers

      void registerForNewAuctionConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new auction constrainers. AuctionConstrainerReceiver.newAuctionConstrainers() is invoked when a new AuctionConstrainer appears in this auction house.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAuctionConstrainers

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

    • registerForChangedAuctionConstrainer

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

    • registerForDeletedAuctionConstrainers

      void registerForDeletedAuctionConstrainers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted auction constrainers. AuctionConstrainerReceiver.deletedAuctionConstrainers() is invoked when an auction constrainer is deleted or removed from this auction house.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAuctionConstrainer

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