Lot QML Type
This value type represent a lot in a document. More...
Import Statement: | import BrickLink 1.0 |
Properties
- alternate : bool
- alternateId : uint
- bulkQuantity : int
- category : Category
- categoryName : string
- color : Color
- colorName : string
- comments : string
- condition : Condition
- cost : real
- counterPart : bool
- dateAdded : date
- dateLastSold : date
- id : string
- image : image
- incomplete : bool
- isMarked : bool
- isNull : bool
- item : Item
- itemId : string
- itemName : string
- itemType : ItemType
- itemTypeName : string
- itemYearLastProduced : int
- itemYearReleased : int
- lotId : uint
- markerColor : color
- markerText : string
- name : string
- price : real
- quantity : int
- remarks : string
- reserved : string
- retain : bool
- sale : int
- status : Status
- stockroom : Stockroom
- subCondition : SubCondition
- tier1Price : real
- tier1Quantity : int
- tier2Price : real
- tier2Quantity : int
- tier3Price : real
- tier3Quantity : int
- total : real
- totalWeight : real
- weight : real
Detailed Description
A Lot corresponds to a row in a BrickStore document.
Property Documentation
alternate : bool |
A boolean flag denoting this lot as an alternate in a set inventory.
Note: This value does not get saved.
alternateId : uint |
If this lot is an alternate in a set inventory, this property holds the alternate id.
Note: This value does not get saved.
bulkQuantity : int |
The bulk quantity. This lot can only be sold in multiple of this.
[read-only] category : Category |
The Category of the lot's item or BrickLink::noCategory, if the lot's item is not valid.
[read-only] categoryName : string |
The category name of the lot's item. The same as item.category.name
, but you don't have to check for isNull on item
.
color : Color |
The Color selected for this lot. Can be BrickLink::noColor, if there's no color set.
[read-only] colorName : string |
The color name of the lot's item. The same as color.name
, but you don't have to check for isNull on color
.
comments : string |
The comment or description for this lot. This is the public text that a buyer can see.
condition : Condition |
Describes the condition of this lot. The Condition enumeration has these values:
Constant | Description |
---|---|
BrickLink.Condition.New | The items in this lot are new. |
BrickLink.Condition.Used | The items in this lot are used. |
cost : real |
The unit cost of the item.
counterPart : bool |
A boolean flag denoting this lot as a counter part in a set inventory.
Note: This value does not get saved.
dateAdded : date |
The date this lot was added to a document (or your store).
dateLastSold : date |
The date this lot was sold in your store.
[read-only] id : string |
Obsolete. Please use itemId instead.
[read-only] image : image |
The item's image in the lot's color; can be null
.
Note: The image isn't readily available, but needs to be asynchronously loaded (or even downloaded) at runtime. See the Picture type for more information.
[read-only] incomplete : bool |
Returns false
if this lot has a valid item and color, or true
otherwise.
[read-only] isMarked : bool |
A boolean flag denoting whether this lot is marked in the document, i.e. it has a non-empty markerText or markerColor.
[read-only] isNull : bool |
Returns whether this Lot is null
. Since this type is a value wrapper around a C++ object, we cannot use the normal JavaScript null
notation.
item : Item |
The Item represented by this lot. Can be a BrickLink::noItem, if there's no item set.
[read-only] itemId : string |
The id of the lot's item. The same as item.id
, but you don't have to check for isNull on item
.
[read-only] itemName : string |
The name of the lot's item. The same as item.name
, but you don't have to check for isNull on item
.
[read-only] itemType : ItemType |
The ItemType of the lot's item or BrickLink::noItemType, if the lot's item is not valid.
[read-only] itemTypeName : string |
The item-type name of the lot's item. The same as item.itemType.name
, but you don't have to check for isNull on item
.
[read-only] itemYearLastProduced : int |
The year the lot's item was last produced.
[read-only] itemYearReleased : int |
The year the lot's item was first released.
lotId : uint |
The BrickLink lot-id, which uniquely identifies a lot for sale on BrickLink.
markerColor : color |
The color of the marker, if this lot is marked.
markerText : string |
The text of the marker, if this lot is marked.
[read-only] name : string |
Obsolete. Please use itemName instead.
price : real |
The unit price of the item.
quantity : int |
The quantity of the item.
remarks : string |
The remark is the private text that only the seller can see.
reserved : string |
The name of the buyer this item is reserved for or an empty string.
retain : bool |
A boolean flag indicating whether the lot should be retained in the store's stockroom if the last item has been sold.
sale : int |
The optional sale on this lots in percent. [0 .. 100]
status : Status |
Represents the status of this lot. The Status enumeration has these values:
Constant | Description |
---|---|
BrickLink.Status.Include | The green check mark in the UI. |
BrickLink.Status.Exclude | The red stop sign in the UI. |
BrickLink.Status.Extra | The blue plus sign in the UI. |
stockroom : Stockroom |
Describes if and in which stockroom this lot is located. The Stockroom enumeration has these values:
Constant | Description |
---|---|
BrickLink.Stockroom.None | Not in a stockroom. |
BrickLink.Stockroom.A | In stockroom A . |
BrickLink.Stockroom.B | In stockroom B . |
BrickLink.Stockroom.C | In stockroom C . |
subCondition : SubCondition |
Describes the sub-condition of this lot, if it represents a set. The SubCondition enumeration has these values:
Constant | Description |
---|---|
BrickLink.SubCondition.None | No sub-condition is set. |
BrickLink.SubCondition.Complete | The set is complete. |
BrickLink.SubCondition.Incomplete | The set is not complete. |
BrickLink.SubCondition.Sealed | The set is still sealed. |
tier1Price : real |
The tier-3 price: this will be the price, if a buyer buys tier1Quantity or more parts.
Note: This value needs to be smaller than price.
tier1Quantity : int |
The tier-1 quantity: if a buyer buys this quantity or more, the price will be tier1Price instead of price.
tier2Price : real |
The tier-3 price: this will be the price, if a buyer buys tier2Quantity or more parts.
Note: This value needs to be smaller than tier2Price.
tier2Quantity : int |
The tier-2 quantity: if a buyer buys this quantity or more, the price will be tier2Price instead of tier1Price.
Note: This value needs to be larger than tier1Quantity.
tier3Price : real |
The tier-3 price: this will be the price, if a buyer buys tier3Quantity or more parts.
Note: This value needs to be smaller than tier2Price.
tier3Quantity : int |
The tier-3 quantity: if a buyer buys this quantity or more, the price will be tier3Price instead of tier2Price.
Note: This value needs to be larger than tier2Quantity.
weight : real |
The weight of a single item in the lot.
© 2004-2024 Robert Griebl. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. All trademarks are property of their respective owners.