A named group of auctions run together as one event, holding the auctions and the default start and end dates new ones inherit. A set belongs to one account and its name is used to look it up, so it acts as the container an administrator manages a run of auctions from. Creating an auction inside a set copies the set's start and end dates onto the auction, after which each auction keeps its own dates. Sets are soft deleted: deleting one stamps deletedBy and deletedDate, deletes its auctions as well, and the finders skip anything with a deleted date.

Group: Database Entities

Implements: Serializable, Relational

---

Properties

---

Methods

getId() · setId(long id) · setOrganisation(Organisation organisation) · getName() · setName(String name) · getTitle() · setTitle(String title) · getCreatedDate() · setCreatedDate(Date createdDate) · getCreatedBy() · setCreatedBy(Profile createdBy) · getDeletedBy() · setDeletedBy(Profile deletedBy) · getDeletedDate() · setDeletedDate(Date deletedDate) · getAuctionStartDate() · setAuctionStartDate(Date auctionStartDate) · getAuctionEndDate() · setAuctionEndDate(Date auctionEndDate) · getAuctions() · setAuctions(List<Auction> auctions)

getId()

Returns: long

Database identifier for this auction set.

setId(long id)

Returns: void

Sets the database identifier. Normally only assigned by the persistence layer.

setOrganisation(Organisation organisation)

Returns: void

Sets the account this set belongs to. Required.

getName()

Returns: String

Portable, path safe identifier for the set, intended to be unique within the account and used as the lookup key. Use getTitle for anything shown to a user. Never null.

setName(String name)

Returns: void

Sets the portable identifier for the set. Required, and it should be unique within the account and safe to use in a URL path.

getTitle()

Returns: String

Free text display label for the set, which is what lists of sets are sorted by. Not unique and not safe to use as an identifier or path segment.

setTitle(String title)

Returns: void

Sets the display label shown to users.

getCreatedDate()

Returns: Date

Date and time the set was created.

setCreatedDate(Date createdDate)

Returns: void

Sets the date and time the set was created.

getCreatedBy()

Returns: Profile

The administrator who created the set. Never null, and lazily loaded.

setCreatedBy(Profile createdBy)

Returns: void

Sets the administrator who created the set. Required.

getDeletedBy()

Returns: Profile

The administrator who deleted the set, for a set that has been soft deleted. Lazily loaded.

setDeletedBy(Profile deletedBy)

Returns: void

Sets the administrator who deleted the set.

getDeletedDate()

Returns: Date

Date and time the set was soft deleted. The finders exclude any set with a deleted date, so setting it hides the set without removing the row.

setDeletedDate(Date deletedDate)

Returns: void

Marks the set as deleted from the given date, or clears the deletion by setting null.

getAuctionStartDate()

Returns: Date

Default start date for auctions in this set. It is copied onto an auction when the auction is created in the set, and changing it afterwards does not move auctions that already exist.

setAuctionStartDate(Date auctionStartDate)

Returns: void

Sets the default start date applied to auctions created in this set.

getAuctionEndDate()

Returns: Date

Default end date for auctions in this set. It is copied onto an auction when the auction is created in the set, and changing it afterwards does not move auctions that already exist.

setAuctionEndDate(Date auctionEndDate)

Returns: void

Sets the default end date applied to auctions created in this set.

getAuctions()

Returns: List<Auction>

The auctions belonging to this set, including any that have been soft deleted. Null rather than empty for a set that has never had an auction added.

setAuctions(List<Auction> auctions)

Returns: void

Replaces the list of auctions in this set. Prefer addAuction and removeAuction, which keep the list consistent and save the change.