org.osid.bidding

Interface Bid

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

public interface Bid
extends OsidRelationship

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

Method Summary

Methods

Modifier and Type	Method and Description
Auction	getAuction() Gets the auction.
Id	getAuctionId() Gets the Id of the auction.
Resource	getBidder() Gets the bidder.
Id	getBidderId() Gets the Id of the bidder.
Agent	getBiddingAgent() Gets the bidding agent.
Id	getBiddingAgentId() Gets the Id of the bidding agent.
BidRecord	getBidRecord(Type bidRecordType) Gets the bid record corresponding to the given Bid record Type.
Currency	getCurrentBid() Gets the current bid amount.
Currency	getMaximumBid() Gets the maximum bid.
long	getQuantity() Gets the quantity of items in this bid.
Currency	getSettlementAmount() Gets the settlement amount owed from the bidder.
boolean	isWinner() Tests if this was a winning bid.

Methods inherited from interface org.osid.OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getAuctionId

Id getAuctionId()

Gets the Id of the auction.

Returns:

the auction Id

Compliance:

mandatory - This method must be implemented.

getAuction

Auction getAuction()
                   throws OperationFailedException

Gets the auction.

Returns:

the auction

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getBidderId

Id getBidderId()

Gets the Id of the bidder.

Returns:

the resource Id

Compliance:

mandatory - This method must be implemented.

getBidder

Resource getBidder()
                   throws OperationFailedException

Gets the bidder.

Returns:

the resource

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getBiddingAgentId

Id getBiddingAgentId()

Gets the Id of the bidding agent.

Returns:

the agent Id

Compliance:

mandatory - This method must be implemented.

getBiddingAgent

Agent getBiddingAgent()
                      throws OperationFailedException

Gets the bidding agent.

Returns:

the agent

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getQuantity

long getQuantity()

Gets the quantity of items in this bid.

Returns:

the quantity of items

Compliance:

mandatory - This method must be implemented.

getCurrentBid

Currency getCurrentBid()

Gets the current bid amount.

Returns:

the current bid

Compliance:

mandatory - This method must be implemented.

getMaximumBid

Currency getMaximumBid()

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.

Returns:

the maximum bid

Compliance:

mandatory - This method must be implemented.

isWinner

boolean isWinner()

Tests if this was a winning bid.

Returns:

true if this was a winnign bid, false otherwise

Compliance:

mandatory - This method must be implemented.

getSettlementAmount

Currency getSettlementAmount()

Gets the settlement amount owed from the bidder.

Returns:

the settlement amount

Compliance:

mandatory - This method must be implemented.

getBidRecord

BidRecord getBidRecord(Type bidRecordType)
                       throws OperationFailedException

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:

bidRecordType - the type of bid record to retrieve

Returns:

the bid record

Throws:

NullArgumentException - bidRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(bidRecordType) is false

Compliance:

mandatory - This method must be implemented.