Package com.clover.sdk.v3.order
Class LineItem
- java.lang.Object
-
- com.clover.sdk.GenericParcelable
-
- com.clover.sdk.v3.order.LineItem
-
- All Implemented Interfaces:
Parcelable
,JSONifiable
,Validator
public class LineItem extends GenericParcelable implements Validator, JSONifiable
This is an auto-generated Clover data object.Fields
id
item
colorCode
name
alternateName
price
priceWithModifiers
priceWithModifiersAndItemAndOrderDiscounts
unitQty
unitName
itemCode
note
printed
exchangedLineItem
binName
userData
createdTime
orderClientCreatedTime
discounts
orderLevelDiscounts
discountAmount
orderLevelDiscountAmount
exchanged
modifications
tags
refunded
refund
isRevenue
taxRates
payments
revenueAmount
quantitySold
printGroup
hidden
percentage
orderFee
isOrderFee
isPlatformOrderFee
- See Also:
IOrderService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
LineItem.Constraints
-
Nested classes/interfaces inherited from interface com.clover.sdk.JSONifiable
JSONifiable.Creator<T>
-
Nested classes/interfaces inherited from interface android.os.Parcelable
Parcelable.ClassLoaderCreator<T extends Object>, Parcelable.Creator<T extends Object>
-
-
Field Summary
Fields Modifier and Type Field Description static Parcelable.Creator<LineItem>
CREATOR
static JSONifiable.Creator<LineItem>
JSON_CREATOR
-
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description LineItem()
Constructs a new empty instance.protected
LineItem(boolean noInit)
Constructs a new empty instance.LineItem(LineItem src)
Constructs a new instance that is a deep copy of the source instance.LineItem(String json)
Constructs a new instance from the given JSON String.LineItem(JSONObject jsonObject)
Construct a new instance backed by the given JSONObject, the parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearAlternateName()
Clears the 'alternateName' field, the 'has' method for this field will now return falsevoid
clearBinName()
Clears the 'binName' field, the 'has' method for this field will now return falsevoid
clearColorCode()
Clears the 'colorCode' field, the 'has' method for this field will now return falsevoid
clearCreatedTime()
Clears the 'createdTime' field, the 'has' method for this field will now return falsevoid
clearDiscountAmount()
Clears the 'discountAmount' field, the 'has' method for this field will now return falsevoid
clearDiscounts()
Clears the 'discounts' field, the 'has' method for this field will now return falsevoid
clearExchanged()
Clears the 'exchanged' field, the 'has' method for this field will now return falsevoid
clearExchangedLineItem()
Clears the 'exchangedLineItem' field, the 'has' method for this field will now return falsevoid
clearHidden()
Clears the 'hidden' field, the 'has' method for this field will now return falsevoid
clearId()
Clears the 'id' field, the 'has' method for this field will now return falsevoid
clearIsOrderFee()
Clears the 'isOrderFee' field, the 'has' method for this field will now return falsevoid
clearIsPlatformOrderFee()
Clears the 'isPlatformOrderFee' field, the 'has' method for this field will now return falsevoid
clearIsRevenue()
Clears the 'isRevenue' field, the 'has' method for this field will now return falsevoid
clearItem()
Clears the 'item' field, the 'has' method for this field will now return falsevoid
clearItemCode()
Clears the 'itemCode' field, the 'has' method for this field will now return falsevoid
clearModifications()
Clears the 'modifications' field, the 'has' method for this field will now return falsevoid
clearName()
Clears the 'name' field, the 'has' method for this field will now return falsevoid
clearNote()
Clears the 'note' field, the 'has' method for this field will now return falsevoid
clearOrderClientCreatedTime()
Clears the 'orderClientCreatedTime' field, the 'has' method for this field will now return falsevoid
clearOrderFee()
Clears the 'orderFee' field, the 'has' method for this field will now return falsevoid
clearOrderLevelDiscountAmount()
Clears the 'orderLevelDiscountAmount' field, the 'has' method for this field will now return falsevoid
clearOrderLevelDiscounts()
Clears the 'orderLevelDiscounts' field, the 'has' method for this field will now return falsevoid
clearPayments()
Clears the 'payments' field, the 'has' method for this field will now return falsevoid
clearPercentage()
Clears the 'percentage' field, the 'has' method for this field will now return falsevoid
clearPrice()
Clears the 'price' field, the 'has' method for this field will now return falsevoid
clearPriceWithModifiers()
Clears the 'priceWithModifiers' field, the 'has' method for this field will now return falsevoid
clearPriceWithModifiersAndItemAndOrderDiscounts()
Clears the 'priceWithModifiersAndItemAndOrderDiscounts' field, the 'has' method for this field will now return falsevoid
clearPrinted()
Clears the 'printed' field, the 'has' method for this field will now return falsevoid
clearPrintGroup()
Clears the 'printGroup' field, the 'has' method for this field will now return falsevoid
clearQuantitySold()
Clears the 'quantitySold' field, the 'has' method for this field will now return falsevoid
clearRefund()
Clears the 'refund' field, the 'has' method for this field will now return falsevoid
clearRefunded()
Clears the 'refunded' field, the 'has' method for this field will now return falsevoid
clearRevenueAmount()
Clears the 'revenueAmount' field, the 'has' method for this field will now return falsevoid
clearTags()
Clears the 'tags' field, the 'has' method for this field will now return falsevoid
clearTaxRates()
Clears the 'taxRates' field, the 'has' method for this field will now return falsevoid
clearUnitName()
Clears the 'unitName' field, the 'has' method for this field will now return falsevoid
clearUnitQty()
Clears the 'unitQty' field, the 'has' method for this field will now return falsevoid
clearUserData()
Clears the 'userData' field, the 'has' method for this field will now return falseboolean
containsChanges()
Returns true if this instance has any changes.LineItem
copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.String
getAlternateName()
Alternate name of the line item.String
getBinName()
String
getColorCode()
Hex code representation of the color assigned to item in the form of #fff, #ffffff, or #ffffffff.Long
getCreatedTime()
Long
getDiscountAmount()
Unnamed fixed discount amount in cents.List<Discount>
getDiscounts()
List of discounts applied to the line item.Boolean
getExchanged()
Reference
getExchangedLineItem()
protected GenericClient
getGenericClient()
Boolean
getHidden()
True if this line item has been marked as hidden on User Interface like Orders page and receiptsString
getId()
Unique identifier.Boolean
getIsOrderFee()
True if this line item is an order fee line itemBoolean
getIsPlatformOrderFee()
True if this line item is an platform order fee line itemBoolean
getIsRevenue()
True if this item should be counted as revenue, for example gift cards and donations would not.Reference
getItem()
A reference to the inventory item that was used to create this line item.String
getItemCode()
JSONObject
getJSONObject()
Returns the internal JSONObject backing this instance, the return value is not a copy so changes to it will be reflected in this instance and vice-versa.List<Modification>
getModifications()
List of references to modifications applied to this line item.String
getName()
Line item name.String
getNote()
Long
getOrderClientCreatedTime()
Reference
getOrderFee()
A reference to the inventory order fee that was used to create this line item.Long
getOrderLevelDiscountAmount()
The calculated sum of order level discounts attributed, approximately to the nearest cent, to this the line item.List<Discount>
getOrderLevelDiscounts()
List of order level discounts attributed to this line item.List<LineItemPayment>
getPayments()
Payments that apply to this line itemLong
getPercentage()
For percentage based order fee line item, percent to charge times 10000, e.g.Long
getPrice()
Price of the item, typically in cents of merchant currency.Long
getPriceWithModifiers()
Price of item after adding all modifications.Long
getPriceWithModifiersAndItemAndOrderDiscounts()
Price of item after adding all modifications and subtracting all line item and order level discounts.Boolean
getPrinted()
True if this line item has been printed out on an order printer at least once already.Reference
getPrintGroup()
Optional reference to the print group that this line item belongs to.Double
getQuantitySold()
Quantity sold for this line item.Refund
getRefund()
direct item refundBoolean
getRefunded()
True if this line item has been refundedLong
getRevenueAmount()
Revenue collected for this.List<Tag>
getTags()
List of tags associated with this line item.List<TaxRate>
getTaxRates()
Tax rates that apply to this line itemString
getUnitName()
Unit name (e.g.Integer
getUnitQty()
This is applicable only if the item is priced by quantity of a unit.String
getUserData()
boolean
hasAlternateName()
Checks whether the 'alternateName' field has been set, however the value could be nullboolean
hasBinName()
Checks whether the 'binName' field has been set, however the value could be nullboolean
hasColorCode()
Checks whether the 'colorCode' field has been set, however the value could be nullboolean
hasCreatedTime()
Checks whether the 'createdTime' field has been set, however the value could be nullboolean
hasDiscountAmount()
Checks whether the 'discountAmount' field has been set, however the value could be nullboolean
hasDiscounts()
Checks whether the 'discounts' field has been set, however the value could be nullboolean
hasExchanged()
Checks whether the 'exchanged' field has been set, however the value could be nullboolean
hasExchangedLineItem()
Checks whether the 'exchangedLineItem' field has been set, however the value could be nullboolean
hasHidden()
Checks whether the 'hidden' field has been set, however the value could be nullboolean
hasId()
Checks whether the 'id' field has been set, however the value could be nullboolean
hasIsOrderFee()
Checks whether the 'isOrderFee' field has been set, however the value could be nullboolean
hasIsPlatformOrderFee()
Checks whether the 'isPlatformOrderFee' field has been set, however the value could be nullboolean
hasIsRevenue()
Checks whether the 'isRevenue' field has been set, however the value could be nullboolean
hasItem()
Checks whether the 'item' field has been set, however the value could be nullboolean
hasItemCode()
Checks whether the 'itemCode' field has been set, however the value could be nullboolean
hasModifications()
Checks whether the 'modifications' field has been set, however the value could be nullboolean
hasName()
Checks whether the 'name' field has been set, however the value could be nullboolean
hasNote()
Checks whether the 'note' field has been set, however the value could be nullboolean
hasOrderClientCreatedTime()
Checks whether the 'orderClientCreatedTime' field has been set, however the value could be nullboolean
hasOrderFee()
Checks whether the 'orderFee' field has been set, however the value could be nullboolean
hasOrderLevelDiscountAmount()
Checks whether the 'orderLevelDiscountAmount' field has been set, however the value could be nullboolean
hasOrderLevelDiscounts()
Checks whether the 'orderLevelDiscounts' field has been set, however the value could be nullboolean
hasPayments()
Checks whether the 'payments' field has been set, however the value could be nullboolean
hasPercentage()
Checks whether the 'percentage' field has been set, however the value could be nullboolean
hasPrice()
Checks whether the 'price' field has been set, however the value could be nullboolean
hasPriceWithModifiers()
Checks whether the 'priceWithModifiers' field has been set, however the value could be nullboolean
hasPriceWithModifiersAndItemAndOrderDiscounts()
Checks whether the 'priceWithModifiersAndItemAndOrderDiscounts' field has been set, however the value could be nullboolean
hasPrinted()
Checks whether the 'printed' field has been set, however the value could be nullboolean
hasPrintGroup()
Checks whether the 'printGroup' field has been set, however the value could be nullboolean
hasQuantitySold()
Checks whether the 'quantitySold' field has been set, however the value could be nullboolean
hasRefund()
Checks whether the 'refund' field has been set, however the value could be nullboolean
hasRefunded()
Checks whether the 'refunded' field has been set, however the value could be nullboolean
hasRevenueAmount()
Checks whether the 'revenueAmount' field has been set, however the value could be nullboolean
hasTags()
Checks whether the 'tags' field has been set, however the value could be nullboolean
hasTaxRates()
Checks whether the 'taxRates' field has been set, however the value could be nullboolean
hasUnitName()
Checks whether the 'unitName' field has been set, however the value could be nullboolean
hasUnitQty()
Checks whether the 'unitQty' field has been set, however the value could be nullboolean
hasUserData()
Checks whether the 'userData' field has been set, however the value could be nullboolean
isNotEmptyDiscounts()
Checks whether the 'discounts' field is set and is not null and is not emptyboolean
isNotEmptyModifications()
Checks whether the 'modifications' field is set and is not null and is not emptyboolean
isNotEmptyOrderLevelDiscounts()
Checks whether the 'orderLevelDiscounts' field is set and is not null and is not emptyboolean
isNotEmptyPayments()
Checks whether the 'payments' field is set and is not null and is not emptyboolean
isNotEmptyTags()
Checks whether the 'tags' field is set and is not null and is not emptyboolean
isNotEmptyTaxRates()
Checks whether the 'taxRates' field is set and is not null and is not emptyboolean
isNotNullAlternateName()
Checks whether the 'alternateName' field is set and is not nullboolean
isNotNullBinName()
Checks whether the 'binName' field is set and is not nullboolean
isNotNullColorCode()
Checks whether the 'colorCode' field is set and is not nullboolean
isNotNullCreatedTime()
Checks whether the 'createdTime' field is set and is not nullboolean
isNotNullDiscountAmount()
Checks whether the 'discountAmount' field is set and is not nullboolean
isNotNullDiscounts()
Checks whether the 'discounts' field is set and is not nullboolean
isNotNullExchanged()
Checks whether the 'exchanged' field is set and is not nullboolean
isNotNullExchangedLineItem()
Checks whether the 'exchangedLineItem' field is set and is not nullboolean
isNotNullHidden()
Checks whether the 'hidden' field is set and is not nullboolean
isNotNullId()
Checks whether the 'id' field is set and is not nullboolean
isNotNullIsOrderFee()
Checks whether the 'isOrderFee' field is set and is not nullboolean
isNotNullIsPlatformOrderFee()
Checks whether the 'isPlatformOrderFee' field is set and is not nullboolean
isNotNullIsRevenue()
Checks whether the 'isRevenue' field is set and is not nullboolean
isNotNullItem()
Checks whether the 'item' field is set and is not nullboolean
isNotNullItemCode()
Checks whether the 'itemCode' field is set and is not nullboolean
isNotNullModifications()
Checks whether the 'modifications' field is set and is not nullboolean
isNotNullName()
Checks whether the 'name' field is set and is not nullboolean
isNotNullNote()
Checks whether the 'note' field is set and is not nullboolean
isNotNullOrderClientCreatedTime()
Checks whether the 'orderClientCreatedTime' field is set and is not nullboolean
isNotNullOrderFee()
Checks whether the 'orderFee' field is set and is not nullboolean
isNotNullOrderLevelDiscountAmount()
Checks whether the 'orderLevelDiscountAmount' field is set and is not nullboolean
isNotNullOrderLevelDiscounts()
Checks whether the 'orderLevelDiscounts' field is set and is not nullboolean
isNotNullPayments()
Checks whether the 'payments' field is set and is not nullboolean
isNotNullPercentage()
Checks whether the 'percentage' field is set and is not nullboolean
isNotNullPrice()
Checks whether the 'price' field is set and is not nullboolean
isNotNullPriceWithModifiers()
Checks whether the 'priceWithModifiers' field is set and is not nullboolean
isNotNullPriceWithModifiersAndItemAndOrderDiscounts()
Checks whether the 'priceWithModifiersAndItemAndOrderDiscounts' field is set and is not nullboolean
isNotNullPrinted()
Checks whether the 'printed' field is set and is not nullboolean
isNotNullPrintGroup()
Checks whether the 'printGroup' field is set and is not nullboolean
isNotNullQuantitySold()
Checks whether the 'quantitySold' field is set and is not nullboolean
isNotNullRefund()
Checks whether the 'refund' field is set and is not nullboolean
isNotNullRefunded()
Checks whether the 'refunded' field is set and is not nullboolean
isNotNullRevenueAmount()
Checks whether the 'revenueAmount' field is set and is not nullboolean
isNotNullTags()
Checks whether the 'tags' field is set and is not nullboolean
isNotNullTaxRates()
Checks whether the 'taxRates' field is set and is not nullboolean
isNotNullUnitName()
Checks whether the 'unitName' field is set and is not nullboolean
isNotNullUnitQty()
Checks whether the 'unitQty' field is set and is not nullboolean
isNotNullUserData()
Checks whether the 'userData' field is set and is not nullvoid
mergeChanges(LineItem src)
Copy all the changed fields from the given source to this instance.void
resetChangeLog()
Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.LineItem
setAlternateName(String alternateName)
Sets the field 'alternateName'.LineItem
setBinName(String binName)
Sets the field 'binName'.LineItem
setColorCode(String colorCode)
Sets the field 'colorCode'.LineItem
setCreatedTime(Long createdTime)
Sets the field 'createdTime'.LineItem
setDiscountAmount(Long discountAmount)
Sets the field 'discountAmount'.LineItem
setDiscounts(List<Discount> discounts)
Sets the field 'discounts'.LineItem
setExchanged(Boolean exchanged)
Sets the field 'exchanged'.LineItem
setExchangedLineItem(Reference exchangedLineItem)
Sets the field 'exchangedLineItem'.LineItem
setHidden(Boolean hidden)
Sets the field 'hidden'.LineItem
setId(String id)
Sets the field 'id'.LineItem
setIsOrderFee(Boolean isOrderFee)
Sets the field 'isOrderFee'.LineItem
setIsPlatformOrderFee(Boolean isPlatformOrderFee)
Sets the field 'isPlatformOrderFee'.LineItem
setIsRevenue(Boolean isRevenue)
Sets the field 'isRevenue'.LineItem
setItem(Reference item)
Sets the field 'item'.LineItem
setItemCode(String itemCode)
Sets the field 'itemCode'.LineItem
setModifications(List<Modification> modifications)
Sets the field 'modifications'.LineItem
setName(String name)
Sets the field 'name'.LineItem
setNote(String note)
Sets the field 'note'.LineItem
setOrderClientCreatedTime(Long orderClientCreatedTime)
Sets the field 'orderClientCreatedTime'.LineItem
setOrderFee(Reference orderFee)
Sets the field 'orderFee'.LineItem
setOrderLevelDiscountAmount(Long orderLevelDiscountAmount)
Sets the field 'orderLevelDiscountAmount'.LineItem
setOrderLevelDiscounts(List<Discount> orderLevelDiscounts)
Sets the field 'orderLevelDiscounts'.LineItem
setPayments(List<LineItemPayment> payments)
Sets the field 'payments'.LineItem
setPercentage(Long percentage)
Sets the field 'percentage'.LineItem
setPrice(Long price)
Sets the field 'price'.LineItem
setPriceWithModifiers(Long priceWithModifiers)
Sets the field 'priceWithModifiers'.LineItem
setPriceWithModifiersAndItemAndOrderDiscounts(Long priceWithModifiersAndItemAndOrderDiscounts)
Sets the field 'priceWithModifiersAndItemAndOrderDiscounts'.LineItem
setPrinted(Boolean printed)
Sets the field 'printed'.LineItem
setPrintGroup(Reference printGroup)
Sets the field 'printGroup'.LineItem
setQuantitySold(Double quantitySold)
Sets the field 'quantitySold'.LineItem
setRefund(Refund refund)
Sets the field 'refund'.LineItem
setRefunded(Boolean refunded)
Sets the field 'refunded'.LineItem
setRevenueAmount(Long revenueAmount)
Sets the field 'revenueAmount'.LineItem
setTags(List<Tag> tags)
Sets the field 'tags'.LineItem
setTaxRates(List<TaxRate> taxRates)
Sets the field 'taxRates'.LineItem
setUnitName(String unitName)
Sets the field 'unitName'.LineItem
setUnitQty(Integer unitQty)
Sets the field 'unitQty'.LineItem
setUserData(String userData)
Sets the field 'userData'.void
validate()
-
Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel
-
-
-
-
Field Detail
-
CREATOR
public static final Parcelable.Creator<LineItem> CREATOR
-
JSON_CREATOR
public static final JSONifiable.Creator<LineItem> JSON_CREATOR
-
-
Constructor Detail
-
LineItem
public LineItem()
Constructs a new empty instance.
-
LineItem
protected LineItem(boolean noInit)
Constructs a new empty instance.
-
LineItem
public LineItem(String json) throws IllegalArgumentException
Constructs a new instance from the given JSON String.- Throws:
IllegalArgumentException
-
LineItem
public LineItem(JSONObject jsonObject)
Construct a new instance backed by the given JSONObject, the parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
LineItem
public LineItem(LineItem src)
Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
-
-
Method Detail
-
getId
public String getId()
Unique identifier.
-
getItem
public Reference getItem()
A reference to the inventory item that was used to create this line item. Note that since this a reference the item can be changed and deleted any time such that it no longer matches this line item.
-
getColorCode
public String getColorCode()
Hex code representation of the color assigned to item in the form of #fff, #ffffff, or #ffffffff. Note that item color can be changed and deleted any time such that it no longer matches this line item
-
getName
public String getName()
Line item name.
-
getAlternateName
public String getAlternateName()
Alternate name of the line item.
-
getPrice
public Long getPrice()
Price of the item, typically in cents of merchant currency. When unit quantity is not null then this is the price for a single unit and is not the complete price.
-
getPriceWithModifiers
public Long getPriceWithModifiers()
Price of item after adding all modifications. This is used only for reporting.
-
getPriceWithModifiersAndItemAndOrderDiscounts
public Long getPriceWithModifiersAndItemAndOrderDiscounts()
Price of item after adding all modifications and subtracting all line item and order level discounts. This is used only for reporting.
-
getUnitQty
public Integer getUnitQty()
This is applicable only if the item is priced by quantity of a unit. The item must have a priceType of PER_UNIT. The value is a fixed-point integer with scaling factor of 1000 (e.g. if charging per ounce, the value should be set to 2500 for 2.5 ounces). To compute the complete price perform the following calculation: PRICE * (UNIT QTY / 1000). If the item doesn’t have a priceType of PER_UNIT, then unitQty is ignored.
-
getUnitName
public String getUnitName()
Unit name (e.g. oz, lb, etc) if priced by unit, otherwise null.
-
getItemCode
public String getItemCode()
-
getNote
public String getNote()
-
getPrinted
public Boolean getPrinted()
True if this line item has been printed out on an order printer at least once already.
-
getExchangedLineItem
public Reference getExchangedLineItem()
-
getBinName
public String getBinName()
-
getUserData
public String getUserData()
-
getCreatedTime
public Long getCreatedTime()
-
getOrderClientCreatedTime
public Long getOrderClientCreatedTime()
-
getDiscounts
public List<Discount> getDiscounts()
List of discounts applied to the line item. Each line item on an order may have zero or more percentage or amount discounts. Line item discounts are separate from order-level discounts (which are applied to the order subtotal).
-
getOrderLevelDiscounts
public List<Discount> getOrderLevelDiscounts()
List of order level discounts attributed to this line item. Amounts are rounded to the nearest penny. This is for reporting purposes only. These rounding approximates are not used when calculating the transaction.
-
getDiscountAmount
public Long getDiscountAmount()
Unnamed fixed discount amount in cents. Or, in reporting, this may be the calculated sum of all the line item discounts.
-
getOrderLevelDiscountAmount
public Long getOrderLevelDiscountAmount()
The calculated sum of order level discounts attributed, approximately to the nearest cent, to this the line item. This is only used in reporting.
-
getExchanged
public Boolean getExchanged()
-
getModifications
public List<Modification> getModifications()
List of references to modifications applied to this line item.
-
getRefunded
public Boolean getRefunded()
True if this line item has been refunded
-
getRefund
public Refund getRefund()
direct item refund
-
getIsRevenue
public Boolean getIsRevenue()
True if this item should be counted as revenue, for example gift cards and donations would not.
-
getPayments
public List<LineItemPayment> getPayments()
Payments that apply to this line item
-
getRevenueAmount
public Long getRevenueAmount()
Revenue collected for this. This field is only used in reporting.
-
getQuantitySold
public Double getQuantitySold()
Quantity sold for this line item. This field is only used in reporting
-
getPrintGroup
public Reference getPrintGroup()
Optional reference to the print group that this line item belongs to.
-
getHidden
public Boolean getHidden()
True if this line item has been marked as hidden on User Interface like Orders page and receipts
-
getPercentage
public Long getPercentage()
For percentage based order fee line item, percent to charge times 10000, e.g. 12.5% will be 125000
-
getOrderFee
public Reference getOrderFee()
A reference to the inventory order fee that was used to create this line item. Note that since this a reference the order fee can be changed and deleted any time such that it no longer matches this line item.
-
getIsOrderFee
public Boolean getIsOrderFee()
True if this line item is an order fee line item
-
getIsPlatformOrderFee
public Boolean getIsPlatformOrderFee()
True if this line item is an platform order fee line item
-
getGenericClient
protected GenericClient getGenericClient()
- Specified by:
getGenericClient
in classGenericParcelable
-
getJSONObject
public JSONObject getJSONObject()
Returns the internal JSONObject backing this instance, the return value is not a copy so changes to it will be reflected in this instance and vice-versa.- Specified by:
getJSONObject
in interfaceJSONifiable
-
isNotNullId
public boolean isNotNullId()
Checks whether the 'id' field is set and is not null
-
isNotNullItem
public boolean isNotNullItem()
Checks whether the 'item' field is set and is not null
-
isNotNullColorCode
public boolean isNotNullColorCode()
Checks whether the 'colorCode' field is set and is not null
-
isNotNullName
public boolean isNotNullName()
Checks whether the 'name' field is set and is not null
-
isNotNullAlternateName
public boolean isNotNullAlternateName()
Checks whether the 'alternateName' field is set and is not null
-
isNotNullPrice
public boolean isNotNullPrice()
Checks whether the 'price' field is set and is not null
-
isNotNullPriceWithModifiers
public boolean isNotNullPriceWithModifiers()
Checks whether the 'priceWithModifiers' field is set and is not null
-
isNotNullPriceWithModifiersAndItemAndOrderDiscounts
public boolean isNotNullPriceWithModifiersAndItemAndOrderDiscounts()
Checks whether the 'priceWithModifiersAndItemAndOrderDiscounts' field is set and is not null
-
isNotNullUnitQty
public boolean isNotNullUnitQty()
Checks whether the 'unitQty' field is set and is not null
-
isNotNullUnitName
public boolean isNotNullUnitName()
Checks whether the 'unitName' field is set and is not null
-
isNotNullItemCode
public boolean isNotNullItemCode()
Checks whether the 'itemCode' field is set and is not null
-
isNotNullNote
public boolean isNotNullNote()
Checks whether the 'note' field is set and is not null
-
isNotNullPrinted
public boolean isNotNullPrinted()
Checks whether the 'printed' field is set and is not null
-
isNotNullExchangedLineItem
public boolean isNotNullExchangedLineItem()
Checks whether the 'exchangedLineItem' field is set and is not null
-
isNotNullBinName
public boolean isNotNullBinName()
Checks whether the 'binName' field is set and is not null
-
isNotNullUserData
public boolean isNotNullUserData()
Checks whether the 'userData' field is set and is not null
-
isNotNullCreatedTime
public boolean isNotNullCreatedTime()
Checks whether the 'createdTime' field is set and is not null
-
isNotNullOrderClientCreatedTime
public boolean isNotNullOrderClientCreatedTime()
Checks whether the 'orderClientCreatedTime' field is set and is not null
-
isNotNullDiscounts
public boolean isNotNullDiscounts()
Checks whether the 'discounts' field is set and is not null
-
isNotEmptyDiscounts
public boolean isNotEmptyDiscounts()
Checks whether the 'discounts' field is set and is not null and is not empty
-
isNotNullOrderLevelDiscounts
public boolean isNotNullOrderLevelDiscounts()
Checks whether the 'orderLevelDiscounts' field is set and is not null
-
isNotEmptyOrderLevelDiscounts
public boolean isNotEmptyOrderLevelDiscounts()
Checks whether the 'orderLevelDiscounts' field is set and is not null and is not empty
-
isNotNullDiscountAmount
public boolean isNotNullDiscountAmount()
Checks whether the 'discountAmount' field is set and is not null
-
isNotNullOrderLevelDiscountAmount
public boolean isNotNullOrderLevelDiscountAmount()
Checks whether the 'orderLevelDiscountAmount' field is set and is not null
-
isNotNullExchanged
public boolean isNotNullExchanged()
Checks whether the 'exchanged' field is set and is not null
-
isNotNullModifications
public boolean isNotNullModifications()
Checks whether the 'modifications' field is set and is not null
-
isNotEmptyModifications
public boolean isNotEmptyModifications()
Checks whether the 'modifications' field is set and is not null and is not empty
-
isNotNullTags
public boolean isNotNullTags()
Checks whether the 'tags' field is set and is not null
-
isNotEmptyTags
public boolean isNotEmptyTags()
Checks whether the 'tags' field is set and is not null and is not empty
-
isNotNullRefunded
public boolean isNotNullRefunded()
Checks whether the 'refunded' field is set and is not null
-
isNotNullRefund
public boolean isNotNullRefund()
Checks whether the 'refund' field is set and is not null
-
isNotNullIsRevenue
public boolean isNotNullIsRevenue()
Checks whether the 'isRevenue' field is set and is not null
-
isNotNullTaxRates
public boolean isNotNullTaxRates()
Checks whether the 'taxRates' field is set and is not null
-
isNotEmptyTaxRates
public boolean isNotEmptyTaxRates()
Checks whether the 'taxRates' field is set and is not null and is not empty
-
isNotNullPayments
public boolean isNotNullPayments()
Checks whether the 'payments' field is set and is not null
-
isNotEmptyPayments
public boolean isNotEmptyPayments()
Checks whether the 'payments' field is set and is not null and is not empty
-
isNotNullRevenueAmount
public boolean isNotNullRevenueAmount()
Checks whether the 'revenueAmount' field is set and is not null
-
isNotNullQuantitySold
public boolean isNotNullQuantitySold()
Checks whether the 'quantitySold' field is set and is not null
-
isNotNullPrintGroup
public boolean isNotNullPrintGroup()
Checks whether the 'printGroup' field is set and is not null
-
isNotNullHidden
public boolean isNotNullHidden()
Checks whether the 'hidden' field is set and is not null
-
isNotNullPercentage
public boolean isNotNullPercentage()
Checks whether the 'percentage' field is set and is not null
-
isNotNullOrderFee
public boolean isNotNullOrderFee()
Checks whether the 'orderFee' field is set and is not null
-
isNotNullIsOrderFee
public boolean isNotNullIsOrderFee()
Checks whether the 'isOrderFee' field is set and is not null
-
isNotNullIsPlatformOrderFee
public boolean isNotNullIsPlatformOrderFee()
Checks whether the 'isPlatformOrderFee' field is set and is not null
-
hasId
public boolean hasId()
Checks whether the 'id' field has been set, however the value could be null
-
hasItem
public boolean hasItem()
Checks whether the 'item' field has been set, however the value could be null
-
hasColorCode
public boolean hasColorCode()
Checks whether the 'colorCode' field has been set, however the value could be null
-
hasName
public boolean hasName()
Checks whether the 'name' field has been set, however the value could be null
-
hasAlternateName
public boolean hasAlternateName()
Checks whether the 'alternateName' field has been set, however the value could be null
-
hasPrice
public boolean hasPrice()
Checks whether the 'price' field has been set, however the value could be null
-
hasPriceWithModifiers
public boolean hasPriceWithModifiers()
Checks whether the 'priceWithModifiers' field has been set, however the value could be null
-
hasPriceWithModifiersAndItemAndOrderDiscounts
public boolean hasPriceWithModifiersAndItemAndOrderDiscounts()
Checks whether the 'priceWithModifiersAndItemAndOrderDiscounts' field has been set, however the value could be null
-
hasUnitQty
public boolean hasUnitQty()
Checks whether the 'unitQty' field has been set, however the value could be null
-
hasUnitName
public boolean hasUnitName()
Checks whether the 'unitName' field has been set, however the value could be null
-
hasItemCode
public boolean hasItemCode()
Checks whether the 'itemCode' field has been set, however the value could be null
-
hasNote
public boolean hasNote()
Checks whether the 'note' field has been set, however the value could be null
-
hasPrinted
public boolean hasPrinted()
Checks whether the 'printed' field has been set, however the value could be null
-
hasExchangedLineItem
public boolean hasExchangedLineItem()
Checks whether the 'exchangedLineItem' field has been set, however the value could be null
-
hasBinName
public boolean hasBinName()
Checks whether the 'binName' field has been set, however the value could be null
-
hasUserData
public boolean hasUserData()
Checks whether the 'userData' field has been set, however the value could be null
-
hasCreatedTime
public boolean hasCreatedTime()
Checks whether the 'createdTime' field has been set, however the value could be null
-
hasOrderClientCreatedTime
public boolean hasOrderClientCreatedTime()
Checks whether the 'orderClientCreatedTime' field has been set, however the value could be null
-
hasDiscounts
public boolean hasDiscounts()
Checks whether the 'discounts' field has been set, however the value could be null
-
hasOrderLevelDiscounts
public boolean hasOrderLevelDiscounts()
Checks whether the 'orderLevelDiscounts' field has been set, however the value could be null
-
hasDiscountAmount
public boolean hasDiscountAmount()
Checks whether the 'discountAmount' field has been set, however the value could be null
-
hasOrderLevelDiscountAmount
public boolean hasOrderLevelDiscountAmount()
Checks whether the 'orderLevelDiscountAmount' field has been set, however the value could be null
-
hasExchanged
public boolean hasExchanged()
Checks whether the 'exchanged' field has been set, however the value could be null
-
hasModifications
public boolean hasModifications()
Checks whether the 'modifications' field has been set, however the value could be null
-
hasTags
public boolean hasTags()
Checks whether the 'tags' field has been set, however the value could be null
-
hasRefunded
public boolean hasRefunded()
Checks whether the 'refunded' field has been set, however the value could be null
-
hasRefund
public boolean hasRefund()
Checks whether the 'refund' field has been set, however the value could be null
-
hasIsRevenue
public boolean hasIsRevenue()
Checks whether the 'isRevenue' field has been set, however the value could be null
-
hasTaxRates
public boolean hasTaxRates()
Checks whether the 'taxRates' field has been set, however the value could be null
-
hasPayments
public boolean hasPayments()
Checks whether the 'payments' field has been set, however the value could be null
-
hasRevenueAmount
public boolean hasRevenueAmount()
Checks whether the 'revenueAmount' field has been set, however the value could be null
-
hasQuantitySold
public boolean hasQuantitySold()
Checks whether the 'quantitySold' field has been set, however the value could be null
-
hasPrintGroup
public boolean hasPrintGroup()
Checks whether the 'printGroup' field has been set, however the value could be null
-
hasHidden
public boolean hasHidden()
Checks whether the 'hidden' field has been set, however the value could be null
-
hasPercentage
public boolean hasPercentage()
Checks whether the 'percentage' field has been set, however the value could be null
-
hasOrderFee
public boolean hasOrderFee()
Checks whether the 'orderFee' field has been set, however the value could be null
-
hasIsOrderFee
public boolean hasIsOrderFee()
Checks whether the 'isOrderFee' field has been set, however the value could be null
-
hasIsPlatformOrderFee
public boolean hasIsPlatformOrderFee()
Checks whether the 'isPlatformOrderFee' field has been set, however the value could be null
-
setItem
public LineItem setItem(Reference item)
Sets the field 'item'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
setAlternateName
public LineItem setAlternateName(String alternateName)
Sets the field 'alternateName'.
-
setPriceWithModifiers
public LineItem setPriceWithModifiers(Long priceWithModifiers)
Sets the field 'priceWithModifiers'.
-
setPriceWithModifiersAndItemAndOrderDiscounts
public LineItem setPriceWithModifiersAndItemAndOrderDiscounts(Long priceWithModifiersAndItemAndOrderDiscounts)
Sets the field 'priceWithModifiersAndItemAndOrderDiscounts'.
-
setExchangedLineItem
public LineItem setExchangedLineItem(Reference exchangedLineItem)
Sets the field 'exchangedLineItem'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
setOrderClientCreatedTime
public LineItem setOrderClientCreatedTime(Long orderClientCreatedTime)
Sets the field 'orderClientCreatedTime'.
-
setDiscounts
public LineItem setDiscounts(List<Discount> discounts)
Sets the field 'discounts'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
-
setOrderLevelDiscounts
public LineItem setOrderLevelDiscounts(List<Discount> orderLevelDiscounts)
Sets the field 'orderLevelDiscounts'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
-
setDiscountAmount
public LineItem setDiscountAmount(Long discountAmount)
Sets the field 'discountAmount'.
-
setOrderLevelDiscountAmount
public LineItem setOrderLevelDiscountAmount(Long orderLevelDiscountAmount)
Sets the field 'orderLevelDiscountAmount'.
-
setModifications
public LineItem setModifications(List<Modification> modifications)
Sets the field 'modifications'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
-
setTags
public LineItem setTags(List<Tag> tags)
Sets the field 'tags'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
-
setRefund
public LineItem setRefund(Refund refund)
Sets the field 'refund'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
setTaxRates
public LineItem setTaxRates(List<TaxRate> taxRates)
Sets the field 'taxRates'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
-
setPayments
public LineItem setPayments(List<LineItemPayment> payments)
Sets the field 'payments'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
-
setRevenueAmount
public LineItem setRevenueAmount(Long revenueAmount)
Sets the field 'revenueAmount'.
-
setQuantitySold
public LineItem setQuantitySold(Double quantitySold)
Sets the field 'quantitySold'.
-
setPrintGroup
public LineItem setPrintGroup(Reference printGroup)
Sets the field 'printGroup'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
setOrderFee
public LineItem setOrderFee(Reference orderFee)
Sets the field 'orderFee'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
setIsPlatformOrderFee
public LineItem setIsPlatformOrderFee(Boolean isPlatformOrderFee)
Sets the field 'isPlatformOrderFee'.
-
clearId
public void clearId()
Clears the 'id' field, the 'has' method for this field will now return false
-
clearItem
public void clearItem()
Clears the 'item' field, the 'has' method for this field will now return false
-
clearColorCode
public void clearColorCode()
Clears the 'colorCode' field, the 'has' method for this field will now return false
-
clearName
public void clearName()
Clears the 'name' field, the 'has' method for this field will now return false
-
clearAlternateName
public void clearAlternateName()
Clears the 'alternateName' field, the 'has' method for this field will now return false
-
clearPrice
public void clearPrice()
Clears the 'price' field, the 'has' method for this field will now return false
-
clearPriceWithModifiers
public void clearPriceWithModifiers()
Clears the 'priceWithModifiers' field, the 'has' method for this field will now return false
-
clearPriceWithModifiersAndItemAndOrderDiscounts
public void clearPriceWithModifiersAndItemAndOrderDiscounts()
Clears the 'priceWithModifiersAndItemAndOrderDiscounts' field, the 'has' method for this field will now return false
-
clearUnitQty
public void clearUnitQty()
Clears the 'unitQty' field, the 'has' method for this field will now return false
-
clearUnitName
public void clearUnitName()
Clears the 'unitName' field, the 'has' method for this field will now return false
-
clearItemCode
public void clearItemCode()
Clears the 'itemCode' field, the 'has' method for this field will now return false
-
clearNote
public void clearNote()
Clears the 'note' field, the 'has' method for this field will now return false
-
clearPrinted
public void clearPrinted()
Clears the 'printed' field, the 'has' method for this field will now return false
-
clearExchangedLineItem
public void clearExchangedLineItem()
Clears the 'exchangedLineItem' field, the 'has' method for this field will now return false
-
clearBinName
public void clearBinName()
Clears the 'binName' field, the 'has' method for this field will now return false
-
clearUserData
public void clearUserData()
Clears the 'userData' field, the 'has' method for this field will now return false
-
clearCreatedTime
public void clearCreatedTime()
Clears the 'createdTime' field, the 'has' method for this field will now return false
-
clearOrderClientCreatedTime
public void clearOrderClientCreatedTime()
Clears the 'orderClientCreatedTime' field, the 'has' method for this field will now return false
-
clearDiscounts
public void clearDiscounts()
Clears the 'discounts' field, the 'has' method for this field will now return false
-
clearOrderLevelDiscounts
public void clearOrderLevelDiscounts()
Clears the 'orderLevelDiscounts' field, the 'has' method for this field will now return false
-
clearDiscountAmount
public void clearDiscountAmount()
Clears the 'discountAmount' field, the 'has' method for this field will now return false
-
clearOrderLevelDiscountAmount
public void clearOrderLevelDiscountAmount()
Clears the 'orderLevelDiscountAmount' field, the 'has' method for this field will now return false
-
clearExchanged
public void clearExchanged()
Clears the 'exchanged' field, the 'has' method for this field will now return false
-
clearModifications
public void clearModifications()
Clears the 'modifications' field, the 'has' method for this field will now return false
-
clearTags
public void clearTags()
Clears the 'tags' field, the 'has' method for this field will now return false
-
clearRefunded
public void clearRefunded()
Clears the 'refunded' field, the 'has' method for this field will now return false
-
clearRefund
public void clearRefund()
Clears the 'refund' field, the 'has' method for this field will now return false
-
clearIsRevenue
public void clearIsRevenue()
Clears the 'isRevenue' field, the 'has' method for this field will now return false
-
clearTaxRates
public void clearTaxRates()
Clears the 'taxRates' field, the 'has' method for this field will now return false
-
clearPayments
public void clearPayments()
Clears the 'payments' field, the 'has' method for this field will now return false
-
clearRevenueAmount
public void clearRevenueAmount()
Clears the 'revenueAmount' field, the 'has' method for this field will now return false
-
clearQuantitySold
public void clearQuantitySold()
Clears the 'quantitySold' field, the 'has' method for this field will now return false
-
clearPrintGroup
public void clearPrintGroup()
Clears the 'printGroup' field, the 'has' method for this field will now return false
-
clearHidden
public void clearHidden()
Clears the 'hidden' field, the 'has' method for this field will now return false
-
clearPercentage
public void clearPercentage()
Clears the 'percentage' field, the 'has' method for this field will now return false
-
clearOrderFee
public void clearOrderFee()
Clears the 'orderFee' field, the 'has' method for this field will now return false
-
clearIsOrderFee
public void clearIsOrderFee()
Clears the 'isOrderFee' field, the 'has' method for this field will now return false
-
clearIsPlatformOrderFee
public void clearIsPlatformOrderFee()
Clears the 'isPlatformOrderFee' field, the 'has' method for this field will now return false
-
containsChanges
public boolean containsChanges()
Returns true if this instance has any changes.
-
resetChangeLog
public void resetChangeLog()
Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.
-
copyChanges
public LineItem copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.
-
mergeChanges
public void mergeChanges(LineItem src)
Copy all the changed fields from the given source to this instance.
-
-