OSID Logo
OSID Specifications
bidding rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.rules.AuctionConstrainerNotificationSession
Implementsosid.OsidSession
Description

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.

MethodgetAuctionHouseId
Description

Gets the AuctionHouse Id associated with this session.

Returnosid.id.Idthe AuctionHouse Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouse
Description

Gets the AuctionHouse associated with this session.

Returnosid.bidding.AuctionHousethe auction house
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForAuctionConstrainerNotifications
Description

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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedAuctionHouseView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedAuctionHouseView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this auction house only.

CompliancemandatoryThis method is must be implemented.
MethodreliableAuctionConstrainerNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeAuctionConstrainerNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableAuctionConstrainerNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeAuctionConstrainerNotification
Description

Acknowledge an auction constrainer notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewAuctionConstrainers
Description

Register for notifications of new auction constrainers. AuctionConstrainerReceiver.newAuctionConstrainers() is invoked when a new AuctionConstrainer appears in this auction house.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAuctionConstrainers
Description

Registers for notification of updated auction houses. AuctionConstrainerReceiver.changedAuctionConstrainers() is invoked when an auction constrainer in this auction house is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAuctionConstrainer
Description

Registers for notification of an updated auction constrainer. ProvisionableReceiver.changedAuctionConstrainers() is invoked when the specified auction constrainer in this auction house is changed.

Parametersosid.id.IdauctionConstrainerIdthe Id of the AuctionConstrainer to monitor
ErrorsNULL_ARGUMENT auctionConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAuctionConstrainers
Description

Registers for notification of deleted auction constrainers. AuctionConstrainerReceiver.deletedAuctionConstrainers() is invoked when an auction constrainer is deleted or removed from this auction house.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAuctionConstrainer
Description

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.

Parametersosid.id.IdauctionConstrainerIdthe Id of the AuctionConstrainer to monitor
ErrorsNULL_ARGUMENT auctionConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.