OSID Logo
OSID Specifications
bidding package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.Auction
Implementsosid.OsidGovernator
osid.Temporal
Description

An Auction governs how Bids may be performed. Auctions are temporal where bidding is open if isEffective() is true.

MethodgetCurrencyType
Description

Gets the currency type used in this auction.

Returnosid.type.Typecurrency type
CompliancemandatoryThis method must be implemented.
MethodgetMinimumBidders
Description

Gets the minimum number of bidders required for this auction to complete.

Returncardinalthe minimum number of bidders
CompliancemandatoryThis method must be implemented.
MethodisSealed
Description

Tests if bids in this auction are visible.

Returnboolean true if this auction is sealed, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSellerId
Description

Gets the seller Id.

Returnosid.id.Ida resource Id
CompliancemandatoryThis method must be implemented.
MethodgetSeller
Description

Gets the seller.

Returnosid.resource.Resourcea resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetItemId
Description

Gets the item Id.

Returnosid.id.Ida resource Id
CompliancemandatoryThis method must be implemented.
MethodgetItem
Description

Gets the item.

Returnosid.resource.Resourcea resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetLotSize
Description

Gets the number of items up for bid.

Returncardinalthe initial number of items
CompliancemandatoryThis method must be implemented.
MethodgetRemainingItems
Description

Gets the number of items remaining.

Returncardinalthe number of items remaining
CompliancemandatoryThis method must be implemented.
MethodlimitsItems
Description

Tests if this auction has a maxmimum number of items that can be bought.

Returnboolean true if the auction has an item limit, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetItemLimit
Description

Gets the limit on the number of items that can be bought.

Returncardinalthe item limit
ErrorsILLEGAL_STATE limitsItems() is false
CompliancemandatoryThis method must be implemented.
MethodgetStartingPrice
Description

Gets the starting price per item.

Returnosid.financials.Currencythe starting price
CompliancemandatoryThis method must be implemented.
MethodgetPriceIncrement
Description

Gets the minimum increment amount for successive bids.

Returnosid.financials.Currencythe increment
CompliancemandatoryThis method must be implemented.
MethodhasReservePrice
Description

Tests if a buyout price is available.

Returnboolean true if the auction has a reserve price, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetReservePrice
Description

Gets the reserve price.

Returnosid.financials.Currencythe reserve price
ErrorsILLEGAL_STATE hasReservePrice() is false
CompliancemandatoryThis method must be implemented.
MethodhasBuyoutPrice
Description

Tests if a buyout price is available.

Returnboolean true if the item can be bought out, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBuyoutPrice
Description

Gets the buyout price.

Returnosid.financials.Currencythe buyout price
ErrorsILLEGAL_STATE hasBuyoutPrice() is false
CompliancemandatoryThis method must be implemented.
MethodgetAuctionRecord
Description

Gets the auction record corresponding to the given Auction record Type. This method ie used to retrieve an object implementing the requested record. The auctionRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(auctionRecordType) is true .

Parametersosid.type.TypeauctionRecordTypethe type of auction record to retrieve
Returnosid.bidding.records.AuctionRecordthe auction record
ErrorsNULL_ARGUMENT auctionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(auctionRecordType) is false
CompliancemandatoryThis method must be implemented.