Interface | osid.bidding.Auction | ||
---|---|---|---|
Implements | osid.OsidGovernator | ||
osid.Temporal | |||
Description |
An | ||
Method | getCurrencyType | ||
Description |
Gets the currency type used in this auction. | ||
Return | osid.type.Type | currency type | |
Compliance | mandatory | This method must be implemented. | |
Method | getMinimumBidders | ||
Description |
Gets the minimum number of bidders required for this auction to complete. | ||
Return | cardinal | the minimum number of bidders | |
Compliance | mandatory | This method must be implemented. | |
Method | isSealed | ||
Description |
Tests if bids in this auction are visible. | ||
Return | boolean | true if this auction is sealed, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSellerId | ||
Description |
Gets the seller | ||
Return | osid.id.Id | a resource Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getSeller | ||
Description |
Gets the seller. | ||
Return | osid.resource.Resource | a resource | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | getItemId | ||
Description |
Gets the item | ||
Return | osid.id.Id | a resource Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getItem | ||
Description |
Gets the item. | ||
Return | osid.resource.Resource | a resource | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | getLotSize | ||
Description |
Gets the number of items up for bid. | ||
Return | cardinal | the initial number of items | |
Compliance | mandatory | This method must be implemented. | |
Method | getRemainingItems | ||
Description |
Gets the number of items remaining. | ||
Return | cardinal | the number of items remaining | |
Compliance | mandatory | This method must be implemented. | |
Method | limitsItems | ||
Description |
Tests if this auction has a maxmimum number of items that can be bought. | ||
Return | boolean | true if the auction has an item limit, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getItemLimit | ||
Description |
Gets the limit on the number of items that can be bought. | ||
Return | cardinal | the item limit | |
Errors | ILLEGAL_STATE | limitsItems() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getStartingPrice | ||
Description |
Gets the starting price per item. | ||
Return | osid.financials.Currency | the starting price | |
Compliance | mandatory | This method must be implemented. | |
Method | getPriceIncrement | ||
Description |
Gets the minimum increment amount for successive bids. | ||
Return | osid.financials.Currency | the increment | |
Compliance | mandatory | This method must be implemented. | |
Method | hasReservePrice | ||
Description |
Tests if a buyout price is available. | ||
Return | boolean | true if the auction has a reserve price, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getReservePrice | ||
Description |
Gets the reserve price. | ||
Return | osid.financials.Currency | the reserve price | |
Errors | ILLEGAL_STATE | hasReservePrice() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | hasBuyoutPrice | ||
Description |
Tests if a buyout price is available. | ||
Return | boolean | true if the item can be bought out, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBuyoutPrice | ||
Description |
Gets the buyout price. | ||
Return | osid.financials.Currency | the buyout price | |
Errors | ILLEGAL_STATE | hasBuyoutPrice() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionRecord | ||
Description |
Gets the auction record corresponding to the given
| ||
Parameters | osid.type.Type | auctionRecordType | the type of auction record to retrieve |
Return | osid.bidding.records.AuctionRecord | the auction record | |
Errors | NULL_ARGUMENT | auctionRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(auctionRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |