One bid placed on an auction, recording the amount, who placed it, when, and the IP address it came from. Bids are never updated or replaced: each attempt is a new row, so an auction's bid history is the full list of these ordered by change date. Which bid is in front depends on the auction's bidding rules, so a highest bid auction takes the largest amount while a lowest unique bid auction takes the smallest amount nobody else matched; the Auction's leading and winning bid fields hold the answer rather than it being derivable from a bid on its own. The participant is the entity the bid counts for, which can be an organisation rather than the person who placed it. Deleting a bid clears it from the auction's leading and winning bid fields first.

Group: Database Entities

Implements: Serializable, Relational


Properties

PropertyReturnsDescription
auctionAuctionThe auction this bid was placed on. Required.
bidValueBigDecimalThe amount bid, as a decimal. Whether a larger or smaller value is better depends on the auction's bidding rules, so do not assume the highest amount is in front.
changeDateDateWhen the bid was placed. Mandatory, and used to order the bid history and to break ties between equal amounts, where the earlier bid wins.
changedByProfileThe profile who placed the bid. Required. This is the person who acted, which is not necessarily the participant the bid counts for.
extraField1StringFirst free text field an app can store its own data about the bid in. The platform never reads or interprets it, so its meaning is up to whichever app writes it.
extraField2StringSecond free text field an app can store its own data about the bid in. The platform never reads or interprets it, so its meaning is up to whichever app writes it.
extraField3StringThird free text field an app can store its own data about the bid in. The platform never reads or interprets it, so its meaning is up to whichever app writes it.
idlongDatabase generated primary key for this bid.
participantBaseEntityThe entity the bid counts for, which can be an organisation rather than the bidder themselves. Optional, and null for an auction where people bid only on their own behalf.
sourceIPAddressStringThe IP address the bid was submitted from, kept for auditing and for investigating suspicious bidding. Optional, so it can be null.

Methods

getId() · getAuction() · setAuction(Auction auction) · getChangeDate() · setChangeDate(Date changeDate) · getChangedBy() · setChangedBy(Profile changedBy) · getParticipant() · setParticipant(BaseEntity participant) · getBidValue() · setBidValue(BigDecimal bidValue) · getSourceIPAddress() · setSourceIPAddress(String sourceIPAddress) · getExtraField1() · setExtraField1(String extraField) · getExtraField2() · setExtraField2(String extraField) · getExtraField3() · setExtraField3(String extraField)

getId()

Returns: long

Database generated primary key for this bid.

getAuction()

Returns: Auction

The auction this bid was placed on. Required.

setAuction(Auction auction)

Returns: void

Sets the auction this bid was placed on. Required.

ParameterDescription
auctionthe auction being bid on

getChangeDate()

Returns: Date

When the bid was placed. Mandatory, and used to order the bid history and to break ties between equal amounts, where the earlier bid wins.

setChangeDate(Date changeDate)

Returns: void

Sets the date and time the bid was placed. Required.

ParameterDescription
changeDatethe time the bid was placed

getChangedBy()

Returns: Profile

The profile who placed the bid. Required. This is the person who acted, which is not necessarily the participant the bid counts for.

setChangedBy(Profile changedBy)

Returns: void

Sets the profile who placed the bid. Required.

ParameterDescription
changedBythe profile placing the bid

getParticipant()

Returns: BaseEntity

The entity the bid counts for, which can be an organisation rather than the bidder themselves. Optional, and null for an auction where people bid only on their own behalf.

setParticipant(BaseEntity participant)

Returns: void

Sets the entity this bid counts for, where that differs from the profile who placed it.

ParameterDescription
participantthe participating entity, or null

getBidValue()

Returns: BigDecimal

The amount bid, as a decimal. Whether a larger or smaller value is better depends on the auction's bidding rules, so do not assume the highest amount is in front.

setBidValue(BigDecimal bidValue)

Returns: void

Sets the amount bid.

ParameterDescription
bidValuethe amount bid

getSourceIPAddress()

Returns: String

The IP address the bid was submitted from, kept for auditing and for investigating suspicious bidding. Optional, so it can be null.

setSourceIPAddress(String sourceIPAddress)

Returns: void

Records the IP address the bid was submitted from.

ParameterDescription
sourceIPAddressthe bidder's IP address, or null if it is not known

getExtraField1()

Returns: String

First free text field an app can store its own data about the bid in. The platform never reads or interprets it, so its meaning is up to whichever app writes it.

setExtraField1(String extraField)

Returns: void

Sets the first free text field on the bid.

ParameterDescription
extraFieldthe value to store, or null to clear it

getExtraField2()

Returns: String

Second free text field an app can store its own data about the bid in. The platform never reads or interprets it, so its meaning is up to whichever app writes it.

setExtraField2(String extraField)

Returns: void

Sets the second free text field on the bid.

ParameterDescription
extraFieldthe value to store, or null to clear it

getExtraField3()

Returns: String

Third free text field an app can store its own data about the bid in. The platform never reads or interprets it, so its meaning is up to whichever app writes it.

setExtraField3(String extraField)

Returns: void

Sets the third free text field on the bid.

ParameterDescription
extraFieldthe value to store, or null to clear it
To get full access to the Kademi Hub existing customers can login here, or new customers can register here.