org.osid.bidding

Interface Auction

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidGovernator, OsidObject, Sourceable, Temporal

public interface Auction
extends OsidGovernator, Temporal

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

Method Summary

Methods

Modifier and Type	Method and Description
AuctionRecord	getAuctionRecord(Type auctionRecordType) Gets the auction record corresponding to the given Auction record Type.
Currency	getBuyoutPrice() Gets the buyout price.
Type	getCurrencyType() Gets the currency type used in this auction.
Resource	getItem() Gets the item.
Id	getItemId() Gets the item Id.
long	getItemLimit() Gets the limit on the number of items that can be bought.
long	getLotSize() Gets the number of items up for bid.
long	getMinimumBidders() Gets the minimum number of bidders required for this auction to complete.
Currency	getPriceIncrement() Gets the minimum increment amount for successive bids.
long	getRemainingItems() Gets the number of items remaining.
Currency	getReservePrice() Gets the reserve price.
Resource	getSeller() Gets the seller.
Id	getSellerId() Gets the seller Id.
Currency	getStartingPrice() Gets the starting price per item.
boolean	hasBuyoutPrice() Tests if a buyout price is available.
boolean	hasReservePrice() Tests if a buyout price is available.
boolean	isSealed() Tests if bids in this auction are visible.
boolean	limitsItems() Tests if this auction has a maxmimum number of items that can be bought.

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.Operable

isActive, isDisabled, isEnabled, isOperational

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getCurrencyType

Type getCurrencyType()

Gets the currency type used in this auction.

Returns:

currency type

Compliance:

mandatory - This method must be implemented.

getMinimumBidders

long getMinimumBidders()

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

Returns:

the minimum number of bidders

Compliance:

mandatory - This method must be implemented.

isSealed

boolean isSealed()

Tests if bids in this auction are visible.

Returns:

true if this auction is sealed, false otherwise

Compliance:

mandatory - This method must be implemented.

getSellerId

Id getSellerId()

Gets the seller Id.

Returns:

a resource Id

Compliance:

mandatory - This method must be implemented.

getSeller

Resource getSeller()
                   throws OperationFailedException

Gets the seller.

Returns:

a resource

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getItemId

Id getItemId()

Gets the item Id.

Returns:

a resource Id

Compliance:

mandatory - This method must be implemented.

getItem

Resource getItem()
                 throws OperationFailedException

Gets the item.

Returns:

a resource

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getLotSize

long getLotSize()

Gets the number of items up for bid.

Returns:

the initial number of items

Compliance:

mandatory - This method must be implemented.

getRemainingItems

long getRemainingItems()

Gets the number of items remaining.

Returns:

the number of items remaining

Compliance:

mandatory - This method must be implemented.

limitsItems

boolean limitsItems()

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

Returns:

true if the auction has an item limit, false otherwise

Compliance:

mandatory - This method must be implemented.

getItemLimit

long getItemLimit()

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

Returns:

the item limit

Throws:

IllegalStateException - limitsItems() is false

Compliance:

mandatory - This method must be implemented.

getStartingPrice

Currency getStartingPrice()

Gets the starting price per item.

Returns:

the starting price

Compliance:

mandatory - This method must be implemented.

getPriceIncrement

Currency getPriceIncrement()

Gets the minimum increment amount for successive bids.

Returns:

the increment

Compliance:

mandatory - This method must be implemented.

hasReservePrice

boolean hasReservePrice()

Tests if a buyout price is available.

Returns:

true if the auction has a reserve price, false otherwise

Compliance:

mandatory - This method must be implemented.

getReservePrice

Currency getReservePrice()

Gets the reserve price.

Returns:

the reserve price

Throws:

IllegalStateException - hasReservePrice() is false

Compliance:

mandatory - This method must be implemented.

hasBuyoutPrice

boolean hasBuyoutPrice()

Tests if a buyout price is available.

Returns:

true if the item can be bought out, false otherwise

Compliance:

mandatory - This method must be implemented.

getBuyoutPrice

Currency getBuyoutPrice()

Gets the buyout price.

Returns:

the buyout price

Throws:

IllegalStateException - hasBuyoutPrice() is false

Compliance:

mandatory - This method must be implemented.

getAuctionRecord

AuctionRecord getAuctionRecord(Type auctionRecordType)
                               throws OperationFailedException

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 .

Parameters:

auctionRecordType - the type of auction record to retrieve

Returns:

the auction record

Throws:

NullArgumentException - auctionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionRecordType) is false

Compliance:

mandatory - This method must be implemented.