clover-android-sdk/com.clover.sdk.v3.report/Summary

Summary

public class Summary extends GenericParcelable implements Validator, JSONifiable

This is an auto-generated Clover data object.

Fields

Constructors

Summary

public void Summary()

Constructs a new empty instance.

public void Summary(String json)

Constructs a new instance from the given JSON String.

public void Summary(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 Summary(Summary 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<Summary> CREATOR

JSON_CREATOR

public final static JSONifiable.Creator<Summary> JSON_CREATOR

PARCELABLE_WRITE_RETURN_VALUE

public final static int PARCELABLE_WRITE_RETURN_VALUE

Functions

clearAdditionalChargeAmount

public void clearAdditionalChargeAmount()

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

clearAdditionalChargeAmountWithoutInteracV1

public void clearAdditionalChargeAmountWithoutInteracV1()

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

clearAmount

public void clearAmount()

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

clearAmountWithoutTips

public void clearAmountWithoutTips()

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

clearChangeInAmount

public void clearChangeInAmount()

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

clearChangeInNetQuantity

public void clearChangeInNetQuantity()

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

clearDriverTip

public void clearDriverTip()

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

clearEndTimestamp

public void clearEndTimestamp()

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

clearName

public void clearName()

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

clearNum

public void clearNum()

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

clearSegmentLabel

public void clearSegmentLabel()

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

clearServiceChargeAmount

public void clearServiceChargeAmount()

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

clearStartTimestamp

public void clearStartTimestamp()

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

clearTipAmount

public void clearTipAmount()

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

clearTipDetails

public void clearTipDetails()

Clears the 'tipDetails' 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 Summary 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()

getAdditionalChargeAmount

public Long getAdditionalChargeAmount()

Total additional charge amount paid minus the additional charge amount refunded.

getAdditionalChargeAmountWithoutInteracV1

public Long getAdditionalChargeAmountWithoutInteracV1()

Total additional charge amount paid minus the additional charge amount refunded.

getAmount

public Long getAmount()

The amount paid or refunded.

getAmountWithoutTips

public Long getAmountWithoutTips()

The amount paid or refunded.

getBundle

public final Bundle getBundle()

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

getChangeInAmount

public Double getChangeInAmount()

Percent change in amount field for current period compared to previous period.

getChangeInNetQuantity

public Double getChangeInNetQuantity()

Percent change in net quantity field for current period compared to previous period.

getDriverTip

public Long getDriverTip()

Tip amount classified as driver tip based on payment attribute value.

getEndTimestamp

public Long getEndTimestamp()

End of the time period for this summary

getId

public String getId()

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.

getName

public String getName()

Optional name field relevant in some scenarios, for example while storing name of line item for top 5 items sold

getNetQuantity

public Double getNetQuantity()

Optional field, total quantity of items sold

getNum

public Long getNum()

getSegmentLabel

public Integer getSegmentLabel()

An identifier that may be used to align report segments across different merchants.

getServiceChargeAmount

public Long getServiceChargeAmount()

getStartTimestamp

public Long getStartTimestamp()

Beginning of the time period for this summary

getTaxAmount

public Long getTaxAmount()

getTipAmount

public Long getTipAmount()

Tip amount will now include driver tip when applicable.

getTipDetails

public List<Summary> getTipDetails()

Array of summary objects.

hasAdditionalChargeAmount

public boolean hasAdditionalChargeAmount()

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

hasAdditionalChargeAmountWithoutInteracV1

public boolean hasAdditionalChargeAmountWithoutInteracV1()

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

hasAmount

public boolean hasAmount()

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

hasAmountWithoutTips

public boolean hasAmountWithoutTips()

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

hasChangeInAmount

public boolean hasChangeInAmount()

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

hasChangeInNetQuantity

public boolean hasChangeInNetQuantity()

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

hasDriverTip

public boolean hasDriverTip()

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

hasEndTimestamp

public boolean hasEndTimestamp()

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

hasName

public boolean hasName()

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

hasNum

public boolean hasNum()

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

hasSegmentLabel

public boolean hasSegmentLabel()

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

hasServiceChargeAmount

public boolean hasServiceChargeAmount()

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

hasStartTimestamp

public boolean hasStartTimestamp()

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

hasTipAmount

public boolean hasTipAmount()

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

hasTipDetails

public boolean hasTipDetails()

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

isNotEmptyTipDetails

public boolean isNotEmptyTipDetails()

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

isNotNullAdditionalChargeAmount

public boolean isNotNullAdditionalChargeAmount()

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

isNotNullAdditionalChargeAmountWithoutInteracV1

public boolean isNotNullAdditionalChargeAmountWithoutInteracV1()

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

isNotNullAmount

public boolean isNotNullAmount()

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

isNotNullAmountWithoutTips

public boolean isNotNullAmountWithoutTips()

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

isNotNullChangeInAmount

public boolean isNotNullChangeInAmount()

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

isNotNullChangeInNetQuantity

public boolean isNotNullChangeInNetQuantity()

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

isNotNullDriverTip

public boolean isNotNullDriverTip()

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

isNotNullEndTimestamp

public boolean isNotNullEndTimestamp()

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

isNotNullId

public boolean isNotNullId()

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

isNotNullName

public boolean isNotNullName()

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

isNotNullNetQuantity

public boolean isNotNullNetQuantity()

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

isNotNullNum

public boolean isNotNullNum()

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

isNotNullSegmentLabel

public boolean isNotNullSegmentLabel()

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

isNotNullServiceChargeAmount

public boolean isNotNullServiceChargeAmount()

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

isNotNullStartTimestamp

public boolean isNotNullStartTimestamp()

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

isNotNullTaxAmount

public boolean isNotNullTaxAmount()

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

isNotNullTipAmount

public boolean isNotNullTipAmount()

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

isNotNullTipDetails

public boolean isNotNullTipDetails()

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

mergeChanges

public void mergeChanges(Summary 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.

setAdditionalChargeAmount

public Summary setAdditionalChargeAmount(Long additionalChargeAmount)

Sets the field 'additionalChargeAmount'.

setAdditionalChargeAmountWithoutInteracV1

public Summary setAdditionalChargeAmountWithoutInteracV1(Long additionalChargeAmountWithoutInteracV1)

Sets the field 'additionalChargeAmountWithoutInteracV1'.

setAmount

public Summary setAmount(Long amount)

Sets the field 'amount'.

setAmountWithoutTips

public Summary setAmountWithoutTips(Long amountWithoutTips)

Sets the field 'amountWithoutTips'.

setChangeInAmount

public Summary setChangeInAmount(Double changeInAmount)

Sets the field 'changeInAmount'.

setChangeInNetQuantity

public Summary setChangeInNetQuantity(Double changeInNetQuantity)

Sets the field 'changeInNetQuantity'.

setDriverTip

public Summary setDriverTip(Long driverTip)

Sets the field 'driverTip'.

setEndTimestamp

public Summary setEndTimestamp(Long endTimestamp)

Sets the field 'endTimestamp'.

setId

public Summary setId(String id)

Sets the field 'id'.

setName

public Summary setName(String name)

Sets the field 'name'.

setNetQuantity

public Summary setNetQuantity(Double netQuantity)

Sets the field 'netQuantity'.

setNum

public Summary setNum(Long num)

Sets the field 'num'.

setSegmentLabel

public Summary setSegmentLabel(Integer segmentLabel)

Sets the field 'segmentLabel'.

setServiceChargeAmount

public Summary setServiceChargeAmount(Long serviceChargeAmount)

Sets the field 'serviceChargeAmount'.

setStartTimestamp

public Summary setStartTimestamp(Long startTimestamp)

Sets the field 'startTimestamp'.

setTaxAmount

public Summary setTaxAmount(Long taxAmount)

Sets the field 'taxAmount'.

setTipAmount

public Summary setTipAmount(Long tipAmount)

Sets the field 'tipAmount'.

setTipDetails

public Summary setTipDetails(List<Summary> tipDetails)

Sets the field 'tipDetails'.

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)