clover-android-sdk/com.clover.sdk.v3.order/LineItem

LineItem

public class LineItem extends GenericParcelable implements Validator, JSONifiable

This is an auto-generated Clover data object.

Fields

Constructors

LineItem

public void LineItem()

Constructs a new empty instance.

public void LineItem(String json)

Constructs a new instance from the given JSON String.

public void 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.

public void LineItem(LineItem src)

Constructs a new instance that is a deep copy of the source instance.

Types

Constraints

public interface Constraints

Properties

CONTENTS_FILE_DESCRIPTOR

public final static int CONTENTS_FILE_DESCRIPTOR

CREATOR

public final static Parcelable.Creator<LineItem> CREATOR

JSON_CREATOR

public final static JSONifiable.Creator<LineItem> JSON_CREATOR

PARCELABLE_WRITE_RETURN_VALUE

public final static int PARCELABLE_WRITE_RETURN_VALUE

Functions

clearAlternateName

public void clearAlternateName()

Clears the 'alternateName' 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

clearColorCode

public void clearColorCode()

Clears the 'colorCode' 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

clearDiscountAmount

public void clearDiscountAmount()

Clears the 'discountAmount' 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

clearExchanged

public void clearExchanged()

Clears the 'exchanged' 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

clearHidden

public void clearHidden()

Clears the 'hidden' field, the 'has' method for this field will now return false

clearId

public void clearId()

Clears the 'id' 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

clearIsRevenue

public void clearIsRevenue()

Clears the 'isRevenue' 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

clearItemCode

public void clearItemCode()

Clears the 'itemCode' 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

clearName

public void clearName()

Clears the 'name' 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

clearOrderClientCreatedTime

public void clearOrderClientCreatedTime()

Clears the 'orderClientCreatedTime' 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

clearOrderFeeType

public void clearOrderFeeType()

Clears the 'orderFee' 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

clearOrderLevelDiscounts

public void clearOrderLevelDiscounts()

Clears the 'orderLevelDiscounts' 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

clearPercentage

public void clearPercentage()

Clears the 'percentage' 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

clearPrinted

public void clearPrinted()

Clears the 'printed' 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

clearQuantitySold

public void clearQuantitySold()

Clears the 'quantitySold' 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

clearRefunded

public void clearRefunded()

Clears the 'refunded' 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

clearTags

public void clearTags()

Clears the 'tags' 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

clearUnitName

public void clearUnitName()

Clears the 'unitName' 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

clearUserData

public void clearUserData()

Clears the 'userData' field, the 'has' method for this field will now return false

containsChanges

public boolean containsChanges()

Returns true if this instance has any changes.

copyChanges

public LineItem copyChanges()

Create a copy of this instance that contains only fields that were set after the constructor was called.

describeContents

public abstract int describeContents()

public final int describeContents()

getAlternateName

public String getAlternateName()

Alternate name of the line item.

getBinName

public String getBinName()

getBundle

public final Bundle getBundle()

Gets a Bundle which can be used to get and set data attached to this instance.

getColorCode

public String getColorCode()

Hex code representation of the color assigned to item in the form of #fff, #ffffff, or #ffffffff.

getCreatedTime

public Long getCreatedTime()

getDiscountAmount

public Long getDiscountAmount()

Unnamed fixed discount amount in cents.

getDiscounts

public List<Discount> getDiscounts()

List of discounts applied to the line item.

getExchanged

public Boolean getExchanged()

getExchangedLineItem

public Reference getExchangedLineItem()

getHidden

public Boolean getHidden()

True if this line item has been marked as hidden on User Interface like Orders page and receipts

getId

public String getId()

Unique identifier.

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

getIsRevenue

public Boolean getIsRevenue()

True if this item should be counted as revenue, for example gift cards and donations would not.

getItem

public Reference getItem()

A reference to the inventory item that was used to create this line item.

getItemCode

public String getItemCode()

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.

getModifications

public List<Modification> getModifications()

List of references to modifications applied to this line item.

getName

public String getName()

Line item name.

getNote

public String getNote()

getOrderClientCreatedTime

public Long getOrderClientCreatedTime()

getOrderFee

public Reference getOrderFee()

A reference to the inventory order fee that was used to create this line item.

getOrderFeeType

public String getOrderFeeType()

Used to define the type of order fee line item.

getOrderLevelDiscountAmount

public Long getOrderLevelDiscountAmount()

The calculated sum of order level discounts attributed, approximately to the nearest cent, to this the line item.

getOrderLevelDiscounts

public List<Discount> getOrderLevelDiscounts()

List of order level discounts attributed to this line item.

getPayments

public List<LineItemPayment> getPayments()

Payments that apply to this line item

getPercentage

public Long getPercentage()

For percentage based order fee line item, percent to charge times 10000, e.g.

getPrice

public Long getPrice()

Price of the item, typically in cents of merchant currency.

getPriceWithModifiers

public Long getPriceWithModifiers()

Price of item after adding all modifications.

getPriceWithModifiersAndItemAndOrderDiscounts

public Long getPriceWithModifiersAndItemAndOrderDiscounts()

Price of item after adding all modifications and subtracting all line item and order level discounts.

getPrinted

public Boolean getPrinted()

True if this line item has been printed out on an order printer at least once already.

getPrintGroup

public Reference getPrintGroup()

Optional reference to the print group that this line item belongs to.

getQuantitySold

public Double getQuantitySold()

Quantity sold for this line item.

getRefund

public Refund getRefund()

direct item refund

getRefunded

public Boolean getRefunded()

True if this line item has been refunded

getRevenueAmount

public Long getRevenueAmount()

Revenue collected for this.

getTags

public List<Tag> getTags()

List of tags associated with this line item.

getTaxRates

public List<TaxRate> getTaxRates()

Tax rates that apply to this line item

getUnitName

public String getUnitName()

Unit name (e.g.

getUnitQty

public Integer getUnitQty()

This is applicable only if the item is priced by quantity of a unit.

getUserData

public String getUserData()

hasAlternateName

public boolean hasAlternateName()

Checks whether the 'alternateName' 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

hasColorCode

public boolean hasColorCode()

Checks whether the 'colorCode' 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

hasDiscountAmount

public boolean hasDiscountAmount()

Checks whether the 'discountAmount' 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

hasExchanged

public boolean hasExchanged()

Checks whether the 'exchanged' 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

hasHidden

public boolean hasHidden()

Checks whether the 'hidden' field has been set, however the value could be null

hasId

public boolean hasId()

Checks whether the 'id' 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

hasIsRevenue

public boolean hasIsRevenue()

Checks whether the 'isRevenue' 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

hasItemCode

public boolean hasItemCode()

Checks whether the 'itemCode' 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

hasName

public boolean hasName()

Checks whether the 'name' 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

hasOrderClientCreatedTime

public boolean hasOrderClientCreatedTime()

Checks whether the 'orderClientCreatedTime' 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

hasOrderFeeType

public boolean hasOrderFeeType()

Checks whether the 'orderFeeType' 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

hasOrderLevelDiscounts

public boolean hasOrderLevelDiscounts()

Checks whether the 'orderLevelDiscounts' 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

hasPercentage

public boolean hasPercentage()

Checks whether the 'percentage' 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

hasPrinted

public boolean hasPrinted()

Checks whether the 'printed' 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

hasQuantitySold

public boolean hasQuantitySold()

Checks whether the 'quantitySold' 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

hasRefunded

public boolean hasRefunded()

Checks whether the 'refunded' 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

hasTags

public boolean hasTags()

Checks whether the 'tags' 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

hasUnitName

public boolean hasUnitName()

Checks whether the 'unitName' 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

hasUserData

public boolean hasUserData()

Checks whether the 'userData' field has been set, however the value could be null

isNotEmptyDiscounts

public boolean isNotEmptyDiscounts()

Checks whether the 'discounts' field is set and is not null and is not empty

isNotEmptyModifications

public boolean isNotEmptyModifications()

Checks whether the 'modifications' field is set and is not null and is not empty

isNotEmptyOrderLevelDiscounts

public boolean isNotEmptyOrderLevelDiscounts()

Checks whether the 'orderLevelDiscounts' field is set and is not null and is not empty

isNotEmptyPayments

public boolean isNotEmptyPayments()

Checks whether the 'payments' field is set and is not null and is not empty

isNotEmptyTags

public boolean isNotEmptyTags()

Checks whether the 'tags' field is set and is not null and is not empty

isNotEmptyTaxRates

public boolean isNotEmptyTaxRates()

Checks whether the 'taxRates' field is set and is not null and is not empty

isNotNullAlternateName

public boolean isNotNullAlternateName()

Checks whether the 'alternateName' field is set and is not null

isNotNullBinName

public boolean isNotNullBinName()

Checks whether the 'binName' field is set and is not null

isNotNullColorCode

public boolean isNotNullColorCode()

Checks whether the 'colorCode' field is set and is not null

isNotNullCreatedTime

public boolean isNotNullCreatedTime()

Checks whether the 'createdTime' field is set and is not null

isNotNullDiscountAmount

public boolean isNotNullDiscountAmount()

Checks whether the 'discountAmount' field is set and is not null

isNotNullDiscounts

public boolean isNotNullDiscounts()

Checks whether the 'discounts' field is set and is not null

isNotNullExchanged

public boolean isNotNullExchanged()

Checks whether the 'exchanged' field is set and is not null

isNotNullExchangedLineItem

public boolean isNotNullExchangedLineItem()

Checks whether the 'exchangedLineItem' field is set and is not null

isNotNullHidden

public boolean isNotNullHidden()

Checks whether the 'hidden' field is set and is not null

isNotNullId

public boolean isNotNullId()

Checks whether the 'id' 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

isNotNullIsRevenue

public boolean isNotNullIsRevenue()

Checks whether the 'isRevenue' field is set and is not null

isNotNullItem

public boolean isNotNullItem()

Checks whether the 'item' field is set and is not null

isNotNullItemCode

public boolean isNotNullItemCode()

Checks whether the 'itemCode' field is set and is not null

isNotNullModifications

public boolean isNotNullModifications()

Checks whether the 'modifications' field is set and is not null

isNotNullName

public boolean isNotNullName()

Checks whether the 'name' field is set and is not null

isNotNullNote

public boolean isNotNullNote()

Checks whether the 'note' field is set and is not null

isNotNullOrderClientCreatedTime

public boolean isNotNullOrderClientCreatedTime()

Checks whether the 'orderClientCreatedTime' field is set and is not null

isNotNullOrderFee

public boolean isNotNullOrderFee()

Checks whether the 'orderFee' field is set and is not null

isNotNullOrderFeeType

public boolean isNotNullOrderFeeType()

Checks whether the 'orderFeeType' field is set and is not null

isNotNullOrderLevelDiscountAmount

public boolean isNotNullOrderLevelDiscountAmount()

Checks whether the 'orderLevelDiscountAmount' field is set and is not null

isNotNullOrderLevelDiscounts

public boolean isNotNullOrderLevelDiscounts()

Checks whether the 'orderLevelDiscounts' field is set and is not null

isNotNullPayments

public boolean isNotNullPayments()

Checks whether the 'payments' field is set and is not null

isNotNullPercentage

public boolean isNotNullPercentage()

Checks whether the 'percentage' 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

isNotNullPrinted

public boolean isNotNullPrinted()

Checks whether the 'printed' field is set and is not null

isNotNullPrintGroup

public boolean isNotNullPrintGroup()

Checks whether the 'printGroup' field is set and is not null

isNotNullQuantitySold

public boolean isNotNullQuantitySold()

Checks whether the 'quantitySold' field is set and is not null

isNotNullRefund

public boolean isNotNullRefund()

Checks whether the 'refund' field is set and is not null

isNotNullRefunded

public boolean isNotNullRefunded()

Checks whether the 'refunded' field is set and is not null

isNotNullRevenueAmount

public boolean isNotNullRevenueAmount()

Checks whether the 'revenueAmount' field is set and is not null

isNotNullTags

public boolean isNotNullTags()

Checks whether the 'tags' field is set and is not null

isNotNullTaxRates

public boolean isNotNullTaxRates()

Checks whether the 'taxRates' field is set and is not null

isNotNullUnitName

public boolean isNotNullUnitName()

Checks whether the 'unitName' field is set and is not null

isNotNullUnitQty

public boolean isNotNullUnitQty()

Checks whether the 'unitQty' field is set and is not null

isNotNullUserData

public boolean isNotNullUserData()

Checks whether the 'userData' field is set and is not null

mergeChanges

public void mergeChanges(LineItem src)

Copy all the changed fields from the given source to this instance.

resetChangeLog

public void resetChangeLog()

Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.

setAlternateName

public LineItem setAlternateName(String alternateName)

Sets the field 'alternateName'.

setBinName

public LineItem setBinName(String binName)

Sets the field 'binName'.

setColorCode

public LineItem setColorCode(String colorCode)

Sets the field 'colorCode'.

setCreatedTime

public LineItem setCreatedTime(Long createdTime)

Sets the field 'createdTime'.

setDiscountAmount

public LineItem setDiscountAmount(Long discountAmount)

Sets the field 'discountAmount'.

setDiscounts

public LineItem setDiscounts(List<Discount> discounts)

Sets the field 'discounts'.

setExchanged

public LineItem setExchanged(Boolean exchanged)

Sets the field 'exchanged'.

setExchangedLineItem

public LineItem setExchangedLineItem(Reference exchangedLineItem)

Sets the field 'exchangedLineItem'.

setHidden

public LineItem setHidden(Boolean hidden)

Sets the field 'hidden'.

setId

public LineItem setId(String id)

Sets the field 'id'.

setIsOrderFee

public LineItem setIsOrderFee(Boolean isOrderFee)

Sets the field 'isOrderFee'.

setIsPlatformOrderFee

public LineItem setIsPlatformOrderFee(Boolean isPlatformOrderFee)

Sets the field 'isPlatformOrderFee'.

setIsRevenue

public LineItem setIsRevenue(Boolean isRevenue)

Sets the field 'isRevenue'.

setItem

public LineItem setItem(Reference item)

Sets the field 'item'.

setItemCode

public LineItem setItemCode(String itemCode)

Sets the field 'itemCode'.

setModifications

public LineItem setModifications(List<Modification> modifications)

Sets the field 'modifications'.

setName

public LineItem setName(String name)

Sets the field 'name'.

setNote

public LineItem setNote(String note)

Sets the field 'note'.

setOrderClientCreatedTime

public LineItem setOrderClientCreatedTime(Long orderClientCreatedTime)

Sets the field 'orderClientCreatedTime'.

setOrderFee

public LineItem setOrderFee(Reference orderFee)

Sets the field 'orderFee'.

setOrderFeeType

public LineItem setOrderFeeType(String orderFeeType)

Sets the field 'orderFeeType'.

setOrderLevelDiscountAmount

public LineItem setOrderLevelDiscountAmount(Long orderLevelDiscountAmount)

Sets the field 'orderLevelDiscountAmount'.

setOrderLevelDiscounts

public LineItem setOrderLevelDiscounts(List<Discount> orderLevelDiscounts)

Sets the field 'orderLevelDiscounts'.

setPayments

public LineItem setPayments(List<LineItemPayment> payments)

Sets the field 'payments'.

setPercentage

public LineItem setPercentage(Long percentage)

Sets the field 'percentage'.

setPrice

public LineItem setPrice(Long price)

Sets the field 'price'.

setPriceWithModifiers

public LineItem setPriceWithModifiers(Long priceWithModifiers)

Sets the field 'priceWithModifiers'.

setPriceWithModifiersAndItemAndOrderDiscounts

public LineItem setPriceWithModifiersAndItemAndOrderDiscounts(Long priceWithModifiersAndItemAndOrderDiscounts)

Sets the field 'priceWithModifiersAndItemAndOrderDiscounts'.

setPrinted

public LineItem setPrinted(Boolean printed)

Sets the field 'printed'.

setPrintGroup

public LineItem setPrintGroup(Reference printGroup)

Sets the field 'printGroup'.

setQuantitySold

public LineItem setQuantitySold(Double quantitySold)

Sets the field 'quantitySold'.

setRefund

public LineItem setRefund(Refund refund)

Sets the field 'refund'.

setRefunded

public LineItem setRefunded(Boolean refunded)

Sets the field 'refunded'.

setRevenueAmount

public LineItem setRevenueAmount(Long revenueAmount)

Sets the field 'revenueAmount'.

setTags

public LineItem setTags(List<Tag> tags)

Sets the field 'tags'.

setTaxRates

public LineItem setTaxRates(List<TaxRate> taxRates)

Sets the field 'taxRates'.

setUnitName

public LineItem setUnitName(String unitName)

Sets the field 'unitName'.

setUnitQty

public LineItem setUnitQty(Integer unitQty)

Sets the field 'unitQty'.

setUserData

public LineItem setUserData(String userData)

Sets the field 'userData'.

toString

public final String toString()

validate

public void validate()

writeToParcel

public abstract void writeToParcel(Parcel p, int p1)

public final void writeToParcel(Parcel dest, int flags)

LineItem

Fields

See also

Constructors

Types

Properties

Functions