OSID — Bidding Entities

Auction

Osid Governator

An Auction governs how Bids may be performed.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Operable
`isActive`	boolean		`true` if this operable is active, `false` if it is inactive
`isEnabled`	boolean		`true` if this operable is enabled, `false` if the active status is determined by other rules
`isDisabled`	boolean		`true` if this operable is disabled, `false` if the active status is determined by other rules
`isOperational`	boolean		`true` if this operable is operational, `false` otherwise

Name	Syntax	Description
`currencyType`	type	currency type
`minimumBidders`	cardinal	the minimum number of bidders
`isSealed`	boolean	`true` if this auction is sealed, `false` otherwise
`sellerId`	id	a resource `Id`
`seller`	Resource	a resource
`itemId`	id	a resource `Id`
`item`	Resource	a resource
`lotSize`	cardinal	the initial number of items
`remainingItems`	cardinal	the number of items remaining
`limitsItems`	boolean	`true` if the auction has an item limit, `false` otherwise
`itemLimit`	cardinal	the item limit
`startingPrice`	Currency	the starting price
`priceIncrement`	Currency	the increment
`hasReservePrice`	boolean	`true` if the auction has a reserve price, `false` otherwise
`reservePrice`	Currency	the reserve price
`hasBuyoutPrice`	boolean	`true` if the item can be bought out, `false` otherwise
`buyoutPrice`	Currency	the buyout price

Osid Relationship

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

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Temporal
`isEffective`	boolean		`true` if this is effective, `false` otherwise
`startDate`	datetime		the start date
`endDate`	datetime		the end date
OsidRelationship
`hasEndReason`	boolean		`true` if an end reason is available, `false` otherwise
`endReasonId`	id		a state `Id`
`endReason`	State		a state

Name	Syntax	Description
`auctionId`	id	the auction `Id`
`auction`	Auction	the auction
`bidderId`	id	the resource `Id`
`bidder`	Resource	the resource
`biddingAgentId`	id	the agent `Id`
`biddingAgent`	Agent	the agent
`quantity`	cardinal	the quantity of items
`currentBid`	Currency	the current bid
`maximumBid`	Currency	the maximum bid
`isWinner`	boolean	`true` if this was a winnign bid, `false` otherwise
`settlementAmount`	Currency	the settlement amount

Osid Catalog

An AuctionHouse represents a collection of auctions.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Sourceable
`providerId`	id		the provider `Id`
`provider`	Resource		the provider
`brandingIds`	id	⋆	a list of asset `Ids`
`branding`	Asset	⋆	a list of assets
`license`	displaytext		the license