| Interface | osid.bidding.rules.BidEnablerRuleApplicationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.bidding.rules.BiddingRulesManager | ||
osid.bidding.rules.BiddingRulesProxyManager | |||
| Description |
This session provides methods to apply
| ||
| Method | getAuctionHouseId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the AuctionHouse Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuctionHouse | ||
| Description |
Gets the | ||
| Return | osid.bidding.AuctionHouse | the auction house | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignBidEnablers | ||
| 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
| ||
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | assignBidEnablerToBid | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | bidEnablerId | the Id of the BidEnabler |
osid.id.Id | bidId | the Id of the Bid | |
| Errors | ALREADY_EXISTS | bidEnablerId already applied to bidId | |
| NOT_FOUND | bidEnablerId or bidId not found | ||
| NULL_ARGUMENT | bidEnablerId or bidId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignBidEnablerFromBid | ||
| Description |
Removes an existing | ||
| Parameters | osid.id.Id | bidEnablerId | the Id of the BidEnabler |
osid.id.Id | bidId | the Id of the Bid | |
| Errors | NOT_FOUND | bidEnablerId or bidId not found or
bidEnablerId already applied to bidId | |
| NULL_ARGUMENT | bidEnablerId or bidId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSequenceBidEnablers | ||
| Description |
Tests if this user can order | ||
| Return | boolean | false if BidEnabler ordering is not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | moveBidEnablerAhead | ||
| Description |
Reorders bid enablers for a bid by moving the specified bid enabler in front of a reference bid enabler. | ||
| Parameters | osid.id.Id | bidEnablerId | the Id of the BidEnabler |
osid.id.Id | bidId | the Id of the Bid | |
osid.id.Id | referenceId | the reference bid enabler Id | |
| Errors | NOT_FOUND | bidEnablerId, bidId , or referenceId not found
or, bidEnablerId or referenceId not related to
bidId | |
| NULL_ARGUMENT | bidEnablerId, bidId , or referenceId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveBidEnablerBehind | ||
| Description |
Reorders bid enablers for a bid by moving the specified bid enabler behind a reference bid enabler. | ||
| Parameters | osid.id.Id | bidEnablerId | the Id of the BidEnabler |
osid.id.Id | bidId | the Id of the Bid | |
osid.id.Id | referenceId | the reference bid enabler Id | |
| Errors | NOT_FOUND | bidEnablerId, bidId , or referenceId not found
or, bidEnablerId or referenceId not related to
bidId | |
| NULL_ARGUMENT | bidEnablerId, bidId , or referenceId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBidEnablers | ||
| Description |
Reorders a set of bid enablers for a bid. | ||
| Parameters | osid.id.Id[] | bidEnablerIds | the Ids for a set of BidEnablers |
osid.id.Id | bidId | the Id of the Bid | |
| Errors | NOT_FOUND | bidEnablerId, bidId , or referenceId not found
or, bidEnablerId or referenceId not related to
bidId | |
| NULL_ARGUMENT | bidEnablerIds, bidId , or referenceId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |