OSID Logo
OSID Specifications
bidding rules package
Version 3.0.0
Interfaceosid.bidding.rules.BidEnablerRuleApplicationSession
Implementsosid.OsidSession
Used Byosid.bidding.rules.BiddingRulesManager
osid.bidding.rules.BiddingRulesProxyManager
Description

This session provides methods to apply BidEnablers to Bids . Multiple BidEnablers applied to an Bid may be sequenced such that the first positive evaluation results in the BidEnablers used.

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.
MethodcanAssignBidEnablers
Description

Tests if this user can alter bid enabler/bid mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 lookup operations to unauthorized users.

Returnbooleanfalse if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignBidEnablerToBid
Description

Adds an existing BidEnabler to a Bid .

Parametersosid.id.IdbidEnablerIdthe Id of the BidEnabler
osid.id.IdbidIdthe Id of the Bid
ErrorsALREADY_EXISTSbidEnablerId already applied to bidId
NOT_FOUNDbidEnablerId or bidId not found
NULL_ARGUMENTbidEnablerId or bidId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignBidEnablerFromBid
Description

Removes an existing BidEnabler from a Bid .

Parametersosid.id.IdbidEnablerIdthe Id of the BidEnabler
osid.id.IdbidIdthe Id of the Bid
ErrorsNOT_FOUNDbidEnablerId or bidId not found or bidEnablerId already applied to bidId
NULL_ARGUMENTbidEnablerId or bidId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceBidEnablers
Description

Tests if this user can order BidEnablers . A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnbooleanfalse if BidEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveBidEnablerAhead
Description

Reorders bid enablers for a bid by moving the specified bid enabler in front of a reference bid enabler.

Parametersosid.id.IdbidEnablerIdthe Id of the BidEnabler
osid.id.IdbidIdthe Id of the Bid
osid.id.IdreferenceIdthe reference bid enabler Id
ErrorsNOT_FOUNDbidEnablerId, bidId , or referenceId not found or, bidEnablerId or referenceId not related to bidId
NULL_ARGUMENTbidEnablerId, bidId , or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveBidEnablerBehind
Description

Reorders bid enablers for a bid by moving the specified bid enabler behind a reference bid enabler.

Parametersosid.id.IdbidEnablerIdthe Id of the BidEnabler
osid.id.IdbidIdthe Id of the Bid
osid.id.IdreferenceIdthe reference bid enabler Id
ErrorsNOT_FOUNDbidEnablerId, bidId , or referenceId not found or, bidEnablerId or referenceId not related to bidId
NULL_ARGUMENTbidEnablerId, bidId , or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderBidEnablers
Description

Reorders a set of bid enablers for a bid.

Parametersosid.id.Id[]bidEnablerIdsthe Ids for a set of BidEnablers
osid.id.IdbidIdthe Id of the Bid
ErrorsNOT_FOUNDbidEnablerId, bidId , or referenceId not found or, bidEnablerId or referenceId not related to bidId
NULL_ARGUMENTbidEnablerIds, bidId , or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.