Package com.clover.sdk.v3.report
Class LabelSummaryRow
- java.lang.Object
-
- com.clover.sdk.GenericParcelable
-
- com.clover.sdk.v3.report.LabelSummaryRow
-
- All Implemented Interfaces:
Parcelable
,JSONifiable
,Validator
public class LabelSummaryRow extends GenericParcelable implements Validator, JSONifiable
This is an auto-generated Clover data object.Each instance of this represents a summary of all the line items with the label in the name field
Fields
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
LabelSummaryRow.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<LabelSummaryRow>
CREATOR
static JSONifiable.Creator<LabelSummaryRow>
JSON_CREATOR
-
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description LabelSummaryRow()
Constructs a new empty instance.protected
LabelSummaryRow(boolean noInit)
Constructs a new empty instance.LabelSummaryRow(LabelSummaryRow src)
Constructs a new instance that is a deep copy of the source instance.LabelSummaryRow(String json)
Constructs a new instance from the given JSON String.LabelSummaryRow(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
clearDiscountAmount()
Clears the 'discountAmount' 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
clearNet()
Clears the 'net' field, the 'has' method for this field will now return falsevoid
clearNetQuantity()
Clears the 'netQuantity' field, the 'has' method for this field will now return falsevoid
clearNonRevenueAmount()
Clears the 'nonRevenueAmount' field, the 'has' method for this field will now return falsevoid
clearNumLineItems()
Clears the 'numLineItems' field, the 'has' method for this field will now return falsevoid
clearPercentNetSale()
Clears the 'percentNetSale' field, the 'has' method for this field will now return falsevoid
clearRefundAmount()
Clears the 'refundAmount' 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
clearTaxAmount()
Clears the 'taxAmount' field, the 'has' method for this field will now return falsevoid
clearTotalAmount()
Clears the 'totalAmount' field, the 'has' method for this field will now return falseboolean
containsChanges()
Returns true if this instance has any changes.LabelSummaryRow
copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.Long
getDiscountAmount()
Total amount of discountsprotected GenericClient
getGenericClient()
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.String
getName()
The name of the row, like Food, Drinks, Alcohol, etc.Long
getNet()
Total amount minus refund amount.Double
getNetQuantity()
Optional field, total quantity of items soldLong
getNonRevenueAmount()
non revenue Line item priceLong
getNumLineItems()
Total number of line items in this category.Double
getPercentNetSale()
Optional field, percent net sale of item soldLong
getRefundAmount()
Total amount of refunds.Long
getRevenueAmount()
Line item price with modifiers and discountsLong
getTaxAmount()
Total amount of taxes collected.Long
getTotalAmount()
Line item price with modifiers and discounts plus taxboolean
hasDiscountAmount()
Checks whether the 'discountAmount' 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
hasNet()
Checks whether the 'net' field has been set, however the value could be nullboolean
hasNetQuantity()
Checks whether the 'netQuantity' field has been set, however the value could be nullboolean
hasNonRevenueAmount()
Checks whether the 'nonRevenueAmount' field has been set, however the value could be nullboolean
hasNumLineItems()
Checks whether the 'numLineItems' field has been set, however the value could be nullboolean
hasPercentNetSale()
Checks whether the 'percentNetSale' field has been set, however the value could be nullboolean
hasRefundAmount()
Checks whether the 'refundAmount' 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
hasTaxAmount()
Checks whether the 'taxAmount' field has been set, however the value could be nullboolean
hasTotalAmount()
Checks whether the 'totalAmount' field has been set, however the value could be nullboolean
isNotNullDiscountAmount()
Checks whether the 'discountAmount' field is set and is not nullboolean
isNotNullName()
Checks whether the 'name' field is set and is not nullboolean
isNotNullNet()
Checks whether the 'net' field is set and is not nullboolean
isNotNullNetQuantity()
Checks whether the 'netQuantity' field is set and is not nullboolean
isNotNullNonRevenueAmount()
Checks whether the 'nonRevenueAmount' field is set and is not nullboolean
isNotNullNumLineItems()
Checks whether the 'numLineItems' field is set and is not nullboolean
isNotNullPercentNetSale()
Checks whether the 'percentNetSale' field is set and is not nullboolean
isNotNullRefundAmount()
Checks whether the 'refundAmount' field is set and is not nullboolean
isNotNullRevenueAmount()
Checks whether the 'revenueAmount' field is set and is not nullboolean
isNotNullTaxAmount()
Checks whether the 'taxAmount' field is set and is not nullboolean
isNotNullTotalAmount()
Checks whether the 'totalAmount' field is set and is not nullvoid
mergeChanges(LabelSummaryRow 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.LabelSummaryRow
setDiscountAmount(Long discountAmount)
Sets the field 'discountAmount'.LabelSummaryRow
setName(String name)
Sets the field 'name'.LabelSummaryRow
setNet(Long net)
Sets the field 'net'.LabelSummaryRow
setNetQuantity(Double netQuantity)
Sets the field 'netQuantity'.LabelSummaryRow
setNonRevenueAmount(Long nonRevenueAmount)
Sets the field 'nonRevenueAmount'.LabelSummaryRow
setNumLineItems(Long numLineItems)
Sets the field 'numLineItems'.LabelSummaryRow
setPercentNetSale(Double percentNetSale)
Sets the field 'percentNetSale'.LabelSummaryRow
setRefundAmount(Long refundAmount)
Sets the field 'refundAmount'.LabelSummaryRow
setRevenueAmount(Long revenueAmount)
Sets the field 'revenueAmount'.LabelSummaryRow
setTaxAmount(Long taxAmount)
Sets the field 'taxAmount'.LabelSummaryRow
setTotalAmount(Long totalAmount)
Sets the field 'totalAmount'.void
validate()
-
Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel
-
-
-
-
Field Detail
-
CREATOR
public static final Parcelable.Creator<LabelSummaryRow> CREATOR
-
JSON_CREATOR
public static final JSONifiable.Creator<LabelSummaryRow> JSON_CREATOR
-
-
Constructor Detail
-
LabelSummaryRow
public LabelSummaryRow()
Constructs a new empty instance.
-
LabelSummaryRow
protected LabelSummaryRow(boolean noInit)
Constructs a new empty instance.
-
LabelSummaryRow
public LabelSummaryRow(String json) throws IllegalArgumentException
Constructs a new instance from the given JSON String.- Throws:
IllegalArgumentException
-
LabelSummaryRow
public LabelSummaryRow(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.
-
LabelSummaryRow
public LabelSummaryRow(LabelSummaryRow src)
Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
-
-
Method Detail
-
getName
public String getName()
The name of the row, like Food, Drinks, Alcohol, etc.
-
getNumLineItems
public Long getNumLineItems()
Total number of line items in this category.
-
getNet
public Long getNet()
Total amount minus refund amount.
-
getTotalAmount
public Long getTotalAmount()
Line item price with modifiers and discounts plus tax
-
getRevenueAmount
public Long getRevenueAmount()
Line item price with modifiers and discounts
-
getTaxAmount
public Long getTaxAmount()
Total amount of taxes collected.
-
getNonRevenueAmount
public Long getNonRevenueAmount()
non revenue Line item price
-
getDiscountAmount
public Long getDiscountAmount()
Total amount of discounts
-
getRefundAmount
public Long getRefundAmount()
Total amount of refunds. This amount includes the line item price with modifiers and discounts plus tax.
-
getPercentNetSale
public Double getPercentNetSale()
Optional field, percent net sale of item sold
-
getNetQuantity
public Double getNetQuantity()
Optional field, total quantity of items sold
-
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
-
isNotNullName
public boolean isNotNullName()
Checks whether the 'name' field is set and is not null
-
isNotNullNumLineItems
public boolean isNotNullNumLineItems()
Checks whether the 'numLineItems' field is set and is not null
-
isNotNullNet
public boolean isNotNullNet()
Checks whether the 'net' field is set and is not null
-
isNotNullTotalAmount
public boolean isNotNullTotalAmount()
Checks whether the 'totalAmount' field is set and is not null
-
isNotNullRevenueAmount
public boolean isNotNullRevenueAmount()
Checks whether the 'revenueAmount' field is set and is not null
-
isNotNullTaxAmount
public boolean isNotNullTaxAmount()
Checks whether the 'taxAmount' field is set and is not null
-
isNotNullNonRevenueAmount
public boolean isNotNullNonRevenueAmount()
Checks whether the 'nonRevenueAmount' field is set and is not null
-
isNotNullDiscountAmount
public boolean isNotNullDiscountAmount()
Checks whether the 'discountAmount' field is set and is not null
-
isNotNullRefundAmount
public boolean isNotNullRefundAmount()
Checks whether the 'refundAmount' field is set and is not null
-
isNotNullPercentNetSale
public boolean isNotNullPercentNetSale()
Checks whether the 'percentNetSale' field is set and is not null
-
isNotNullNetQuantity
public boolean isNotNullNetQuantity()
Checks whether the 'netQuantity' field is set and is not null
-
hasName
public boolean hasName()
Checks whether the 'name' field has been set, however the value could be null
-
hasNumLineItems
public boolean hasNumLineItems()
Checks whether the 'numLineItems' field has been set, however the value could be null
-
hasNet
public boolean hasNet()
Checks whether the 'net' field has been set, however the value could be null
-
hasTotalAmount
public boolean hasTotalAmount()
Checks whether the 'totalAmount' 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
-
hasTaxAmount
public boolean hasTaxAmount()
Checks whether the 'taxAmount' field has been set, however the value could be null
-
hasNonRevenueAmount
public boolean hasNonRevenueAmount()
Checks whether the 'nonRevenueAmount' 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
-
hasRefundAmount
public boolean hasRefundAmount()
Checks whether the 'refundAmount' field has been set, however the value could be null
-
hasPercentNetSale
public boolean hasPercentNetSale()
Checks whether the 'percentNetSale' field has been set, however the value could be null
-
hasNetQuantity
public boolean hasNetQuantity()
Checks whether the 'netQuantity' field has been set, however the value could be null
-
setName
public LabelSummaryRow setName(String name)
Sets the field 'name'.
-
setNumLineItems
public LabelSummaryRow setNumLineItems(Long numLineItems)
Sets the field 'numLineItems'.
-
setNet
public LabelSummaryRow setNet(Long net)
Sets the field 'net'.
-
setTotalAmount
public LabelSummaryRow setTotalAmount(Long totalAmount)
Sets the field 'totalAmount'.
-
setRevenueAmount
public LabelSummaryRow setRevenueAmount(Long revenueAmount)
Sets the field 'revenueAmount'.
-
setTaxAmount
public LabelSummaryRow setTaxAmount(Long taxAmount)
Sets the field 'taxAmount'.
-
setNonRevenueAmount
public LabelSummaryRow setNonRevenueAmount(Long nonRevenueAmount)
Sets the field 'nonRevenueAmount'.
-
setDiscountAmount
public LabelSummaryRow setDiscountAmount(Long discountAmount)
Sets the field 'discountAmount'.
-
setRefundAmount
public LabelSummaryRow setRefundAmount(Long refundAmount)
Sets the field 'refundAmount'.
-
setPercentNetSale
public LabelSummaryRow setPercentNetSale(Double percentNetSale)
Sets the field 'percentNetSale'.
-
setNetQuantity
public LabelSummaryRow setNetQuantity(Double netQuantity)
Sets the field 'netQuantity'.
-
clearName
public void clearName()
Clears the 'name' field, the 'has' method for this field will now return false
-
clearNumLineItems
public void clearNumLineItems()
Clears the 'numLineItems' field, the 'has' method for this field will now return false
-
clearNet
public void clearNet()
Clears the 'net' field, the 'has' method for this field will now return false
-
clearTotalAmount
public void clearTotalAmount()
Clears the 'totalAmount' 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
-
clearTaxAmount
public void clearTaxAmount()
Clears the 'taxAmount' field, the 'has' method for this field will now return false
-
clearNonRevenueAmount
public void clearNonRevenueAmount()
Clears the 'nonRevenueAmount' 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
-
clearRefundAmount
public void clearRefundAmount()
Clears the 'refundAmount' field, the 'has' method for this field will now return false
-
clearPercentNetSale
public void clearPercentNetSale()
Clears the 'percentNetSale' field, the 'has' method for this field will now return false
-
clearNetQuantity
public void clearNetQuantity()
Clears the 'netQuantity' 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 LabelSummaryRow copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.
-
mergeChanges
public void mergeChanges(LabelSummaryRow src)
Copy all the changed fields from the given source to this instance.
-
-