Package com.clover.sdk.v3.payments
Class PaymentTaxRate
- java.lang.Object
-
- com.clover.sdk.GenericParcelable
-
- com.clover.sdk.v3.payments.PaymentTaxRate
-
- All Implemented Interfaces:
Parcelable
,JSONifiable
,Validator
public class PaymentTaxRate extends GenericParcelable implements Validator, JSONifiable
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
PaymentTaxRate.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<PaymentTaxRate>
CREATOR
static JSONifiable.Creator<PaymentTaxRate>
JSON_CREATOR
-
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description PaymentTaxRate()
Constructs a new empty instance.protected
PaymentTaxRate(boolean noInit)
Constructs a new empty instance.PaymentTaxRate(PaymentTaxRate src)
Constructs a new instance that is a deep copy of the source instance.PaymentTaxRate(String json)
Constructs a new instance from the given JSON String.PaymentTaxRate(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
clearId()
Clears the 'id' field, the 'has' method for this field will now return falsevoid
clearIsDefault()
Clears the 'isDefault' field, the 'has' method for this field will now return falsevoid
clearIsVat()
Clears the 'isVat' 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
clearRate()
Clears the 'rate' field, the 'has' method for this field will now return falsevoid
clearTaxableAmount()
Clears the 'taxableAmount' 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 falseboolean
containsChanges()
Returns true if this instance has any changes.PaymentTaxRate
copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.protected GenericClient
getGenericClient()
String
getId()
Tax rate id.Boolean
getIsDefault()
Whether the tax rate was configued as a default tax rate at the time that the payment was created.Boolean
getIsVat()
Whether merchant is configured as VATJSONObject
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()
Tax rate name.Long
getRate()
The tax rate.Long
getTaxableAmount()
The sub-total of line items that the tax was based on.Long
getTaxAmount()
The amount of tax collected.boolean
hasId()
Checks whether the 'id' field has been set, however the value could be nullboolean
hasIsDefault()
Checks whether the 'isDefault' field has been set, however the value could be nullboolean
hasIsVat()
Checks whether the 'isVat' 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
hasRate()
Checks whether the 'rate' field has been set, however the value could be nullboolean
hasTaxableAmount()
Checks whether the 'taxableAmount' 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
isNotNullId()
Checks whether the 'id' field is set and is not nullboolean
isNotNullIsDefault()
Checks whether the 'isDefault' field is set and is not nullboolean
isNotNullIsVat()
Checks whether the 'isVat' field is set and is not nullboolean
isNotNullName()
Checks whether the 'name' field is set and is not nullboolean
isNotNullRate()
Checks whether the 'rate' field is set and is not nullboolean
isNotNullTaxableAmount()
Checks whether the 'taxableAmount' field is set and is not nullboolean
isNotNullTaxAmount()
Checks whether the 'taxAmount' field is set and is not nullvoid
mergeChanges(PaymentTaxRate 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.PaymentTaxRate
setId(String id)
Sets the field 'id'.PaymentTaxRate
setIsDefault(Boolean isDefault)
Sets the field 'isDefault'.PaymentTaxRate
setIsVat(Boolean isVat)
Sets the field 'isVat'.PaymentTaxRate
setName(String name)
Sets the field 'name'.PaymentTaxRate
setRate(Long rate)
Sets the field 'rate'.PaymentTaxRate
setTaxableAmount(Long taxableAmount)
Sets the field 'taxableAmount'.PaymentTaxRate
setTaxAmount(Long taxAmount)
Sets the field 'taxAmount'.void
validate()
-
Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel
-
-
-
-
Field Detail
-
CREATOR
public static final Parcelable.Creator<PaymentTaxRate> CREATOR
-
JSON_CREATOR
public static final JSONifiable.Creator<PaymentTaxRate> JSON_CREATOR
-
-
Constructor Detail
-
PaymentTaxRate
public PaymentTaxRate()
Constructs a new empty instance.
-
PaymentTaxRate
protected PaymentTaxRate(boolean noInit)
Constructs a new empty instance.
-
PaymentTaxRate
public PaymentTaxRate(String json) throws IllegalArgumentException
Constructs a new instance from the given JSON String.- Throws:
IllegalArgumentException
-
PaymentTaxRate
public PaymentTaxRate(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.
-
PaymentTaxRate
public PaymentTaxRate(PaymentTaxRate 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()
Tax rate id.
-
getName
public String getName()
Tax rate name. This field is optional.
-
getRate
public Long getRate()
The tax rate. 100% = 1e7.
-
getIsDefault
public Boolean getIsDefault()
Whether the tax rate was configued as a default tax rate at the time that the payment was created.
-
getTaxableAmount
public Long getTaxableAmount()
The sub-total of line items that the tax was based on. For VAT, this amount includes tax. For all others, this amount does not include tax.
-
getIsVat
public Boolean getIsVat()
Whether merchant is configured as VAT
-
getTaxAmount
public Long getTaxAmount()
The amount of tax collected. In cases where there are multiple payments for an order then it may be necessary to add an extra cent of tax to the last payment.
-
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
-
isNotNullName
public boolean isNotNullName()
Checks whether the 'name' field is set and is not null
-
isNotNullRate
public boolean isNotNullRate()
Checks whether the 'rate' field is set and is not null
-
isNotNullIsDefault
public boolean isNotNullIsDefault()
Checks whether the 'isDefault' field is set and is not null
-
isNotNullTaxableAmount
public boolean isNotNullTaxableAmount()
Checks whether the 'taxableAmount' field is set and is not null
-
isNotNullIsVat
public boolean isNotNullIsVat()
Checks whether the 'isVat' field is set and is not null
-
isNotNullTaxAmount
public boolean isNotNullTaxAmount()
Checks whether the 'taxAmount' 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
-
hasName
public boolean hasName()
Checks whether the 'name' field has been set, however the value could be null
-
hasRate
public boolean hasRate()
Checks whether the 'rate' field has been set, however the value could be null
-
hasIsDefault
public boolean hasIsDefault()
Checks whether the 'isDefault' field has been set, however the value could be null
-
hasTaxableAmount
public boolean hasTaxableAmount()
Checks whether the 'taxableAmount' field has been set, however the value could be null
-
hasIsVat
public boolean hasIsVat()
Checks whether the 'isVat' 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
-
setId
public PaymentTaxRate setId(String id)
Sets the field 'id'.
-
setName
public PaymentTaxRate setName(String name)
Sets the field 'name'.
-
setRate
public PaymentTaxRate setRate(Long rate)
Sets the field 'rate'.
-
setIsDefault
public PaymentTaxRate setIsDefault(Boolean isDefault)
Sets the field 'isDefault'.
-
setTaxableAmount
public PaymentTaxRate setTaxableAmount(Long taxableAmount)
Sets the field 'taxableAmount'.
-
setIsVat
public PaymentTaxRate setIsVat(Boolean isVat)
Sets the field 'isVat'.
-
setTaxAmount
public PaymentTaxRate setTaxAmount(Long taxAmount)
Sets the field 'taxAmount'.
-
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
-
clearRate
public void clearRate()
Clears the 'rate' field, the 'has' method for this field will now return false
-
clearIsDefault
public void clearIsDefault()
Clears the 'isDefault' field, the 'has' method for this field will now return false
-
clearTaxableAmount
public void clearTaxableAmount()
Clears the 'taxableAmount' field, the 'has' method for this field will now return false
-
clearIsVat
public void clearIsVat()
Clears the 'isVat' 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
-
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 PaymentTaxRate copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.
-
mergeChanges
public void mergeChanges(PaymentTaxRate src)
Copy all the changed fields from the given source to this instance.
-
-