OSID - osid.bidding.Bid Service Interface Definition

Interface	osid.bidding.Bid
Implements	`osid.OsidRelationship`
Used By	`osid.bidding.BidAdminSession`
	`osid.bidding.BidList`
	`osid.bidding.BidLookupSession`
Description	A `Bid` represents a bid for an item at an auction.
Method	getAuctionId
Description	Gets the `Id` of the auction.
Return	`osid.id.Id`		the auction `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getAuction
Description	Gets the auction.
Return	`osid.bidding.Auction`		the auction
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getBidderId
Description	Gets the `Id` of the bidder.
Return	`osid.id.Id`		the resource `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getBidder
Description	Gets the bidder.
Return	`osid.resource.Resource`		the resource
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getBiddingAgentId
Description	Gets the `Id` of the bidding agent.
Return	`osid.id.Id`		the agent `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getBiddingAgent
Description	Gets the bidding agent.
Return	`osid.authentication.Agent`		the agent
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getQuantity
Description	Gets the quantity of items in this bid.
Return	`cardinal`		the quantity of items
Compliance	`mandatory`		This method must be implemented.
Method	getCurrentBid
Description	Gets the current bid amount.
Return	`osid.financials.Currency`		the current bid
Compliance	`mandatory`		This method must be implemented.
Method	getMaximumBid
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.
Return	`osid.financials.Currency`		the maximum bid
Compliance	`mandatory`		This method must be implemented.
Method	isWinner
Description	Tests if this was a winning bid.
Return	`boolean`		`true` if this was a winnign bid, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSettlementAmount
Description	Gets the settlement amount owed from the bidder.
Return	`osid.financials.Currency`		the settlement amount
Compliance	`mandatory`		This method must be implemented.
Method	getBidRecord
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`.
Parameters	`osid.type.Type`	`bidRecordType`	the type of bid record to retrieve
Return	`osid.bidding.records.BidRecord`		the bid record
Errors	NULL_ARGUMENT		`bidRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(bidRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.