| Interface | osid.bidding.MyAuctionSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session defines methods for accessing auctions bid by authenticated agent. | ||
| 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 | canLookupMyAuctions | ||
| Description |
Tests if this user can perform | ||
| Return | boolean | false if lookup methods are not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMyAuctions | ||
| Description |
Gets all the auctions bid by this agent and the auctions in which this agent is a particpant. | ||
| Return | osid.bidding.AuctionList | the returned AuctionList | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getMyOpenAuctions | ||
| Description |
Gets all the auctions open for bidding that have been bid on by this agent and the auctions in which this agent is a particpant. | ||
| Return | osid.bidding.AuctionList | the returned AuctionList | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getMyAuctionsForBidding | ||
| Description |
Gets a list of auctions in which this agent may place another bid. A list of open auctions in which this agent is a participant and not already the highest bidder is returned. Ante auctions where it is the agent's turn are also returned. | ||
| Return | osid.bidding.AuctionList | the returned AuctionList | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getMyAuctionsByDate | ||
| Description |
Gets all the auctions bid by this agent the auctions in which this agent is a particpant where the give date falls within the auction open dates inclusive. | ||
| Parameters | osid.calendaring.DateTime | date | start of date range |
| Return | osid.bidding.AuctionList | the returned AuctionList | |
| Errors | NULL_ARGUMENT | date is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getMyBids | ||
| Description |
Gets all the bids made by this agent. | ||
| Return | osid.bidding.BidList | the returned Bid list | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getMyBidsByDate | ||
| Description |
Gets all the bids bid this agent where the bids have a start effective date within the given date range inclusive. | ||
| Parameters | osid.calendaring.DateTime | start | start of date range |
osid.calendaring.DateTime | end | end of date range | |
| Return | osid.bidding.BidList | the returned BidList | |
| Errors | INVALID_ARGUMENT | start is greater than end | |
| NULL_ARGUMENT | start or end is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getMyBidsForAuction | ||
| Description |
Gets all the bids made by this agent for the given auction. | ||
| Parameters | osid.id.Id | auctionId | an Id of an Auction |
| Return | osid.bidding.BidList | the returned Bid list | |
| Errors | NOT_FOUND | auctionId is bot found | |
| NULL_ARGUMENT | auctionId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getWinningBids | ||
| Description |
Gets all the winning bids made by any agent. | ||
| Return | osid.bidding.BidList | the winning Bid list | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |