OSID Logo
OSID Specifications
bidding package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.Bid
Implementsosid.OsidRelationship
Description

A Bid represents a bid for an item at an auction.

MethodgetAuctionId
Description

Gets the Id of the auction.

Returnosid.id.Idthe auction Id
CompliancemandatoryThis method must be implemented.
MethodgetAuction
Description

Gets the auction.

Returnosid.bidding.Auctionthe auction
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetBidderId
Description

Gets the Id of the bidder.

Returnosid.id.Idthe resource Id
CompliancemandatoryThis method must be implemented.
MethodgetBidder
Description

Gets the bidder.

Returnosid.resource.Resourcethe resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetBiddingAgentId
Description

Gets the Id of the bidding agent.

Returnosid.id.Idthe agent Id
CompliancemandatoryThis method must be implemented.
MethodgetBiddingAgent
Description

Gets the bidding agent.

Returnosid.authentication.Agentthe agent
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetQuantity
Description

Gets the quantity of items in this bid.

Returncardinalthe quantity of items
CompliancemandatoryThis method must be implemented.
MethodgetCurrentBid
Description

Gets the current bid amount.

Returnosid.financials.Currencythe current bid
CompliancemandatoryThis method must be implemented.
MethodgetMaximumBid
Description

Gets the maximum bid. For some auctions, the current bid is the maximum bid. For others, the current bid may be less then the maximum bid and automatically increment when greater bids are made up to the maximum bid.

Returnosid.financials.Currencythe maximum bid
CompliancemandatoryThis method must be implemented.
MethodisWinner
Description

Tests if this was a winning bid.

Returnboolean true if this was a winnign bid, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSettlementAmount
Description

Gets the settlement amount owed from the bidder.

Returnosid.financials.Currencythe settlement amount
CompliancemandatoryThis method must be implemented.
MethodgetBidRecord
Description

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

Parametersosid.type.TypebidRecordTypethe type of bid record to retrieve
Returnosid.bidding.records.BidRecordthe bid record
ErrorsNULL_ARGUMENT bidRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(bidRecordType) is false
CompliancemandatoryThis method must be implemented.