GiftCardTransaction (clover-android-sdk 293 API)

java.lang.Object
- com.clover.sdk.GenericParcelable
- - com.clover.sdk.v3.payments.GiftCardTransaction

All Implemented Interfaces:

Parcelable, JSONifiable, Validator
```
public class GiftCardTransaction
extends GenericParcelable
implements Validator, JSONifiable
```
This is an auto-generated Clover data object.

Fields

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GiftCardTransaction.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>, Parcelable.Creator<T>

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GiftCardTransaction.Constraints`

Field Summary

Fields
Modifier and Type Field and Description

static Parcelable.Creator<GiftCardTransaction> CREATOR

static JSONifiable.Creator<GiftCardTransaction> JSON_CREATOR
- Fields inherited from interface android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Fields
Modifier and Type	Field and Description
`static Parcelable.Creator<GiftCardTransaction>`	`CREATOR`
`static JSONifiable.Creator<GiftCardTransaction>`	`JSON_CREATOR`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`GiftCardTransaction()` Constructs a new empty instance.
`protected`	`GiftCardTransaction(boolean noInit)` Constructs a new empty instance.
	`GiftCardTransaction(GiftCardTransaction src)` Constructs a new instance that is a deep copy of the source instance.
	`GiftCardTransaction(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.
	`GiftCardTransaction(String json)` Constructs a new instance from the given JSON String.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearAmount()` Clears the 'amount' field, the 'has' method for this field will now return false
`void`	`clearCard()` Clears the 'card' field, the 'has' method for this field will now return false
`void`	`clearEmployeeId()` Clears the 'employeeId' field, the 'has' method for this field will now return false
`void`	`clearId()` Clears the 'id' field, the 'has' method for this field will now return false
`void`	`clearIgnorePayment()` Clears the 'ignorePayment' field, the 'has' method for this field will now return false
`void`	`clearLineItems()` Clears the 'lineItems' field, the 'has' method for this field will now return false
`void`	`clearOrderId()` Clears the 'orderId' field, the 'has' method for this field will now return false
`void`	`clearPaymentIds()` Clears the 'paymentIds' field, the 'has' method for this field will now return false
`void`	`clearServiceChargeAmount()` Clears the 'serviceChargeAmount' field, the 'has' method for this field will now return false
`void`	`clearSuppressPayment()` Clears the 'suppressPayment' field, the 'has' method for this field will now return false
`void`	`clearTaxableAmountRates()` Clears the 'taxableAmountRates' field, the 'has' method for this field will now return false
`void`	`clearTaxAmount()` Clears the 'taxAmount' field, the 'has' method for this field will now return false
`void`	`clearTipAmount()` Clears the 'tipAmount' field, the 'has' method for this field will now return false
`boolean`	`containsChanges()` Returns true if this instance has any changes.
`GiftCardTransaction`	`copyChanges()` Create a copy of this instance that contains only fields that were set after the constructor was called.
`Long`	`getAmount()` Transaction Amount
`GiftCard`	`getCard()` Gift Card
`String`	`getEmployeeId()`
`protected GenericClient`	`getGenericClient()`
`String`	`getId()` UUID
`Boolean`	`getIgnorePayment()`
`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<LineItemPayment>`	`getLineItems()` Payments that were made for this line item
`String`	`getOrderId()`
`List<String>`	`getPaymentIds()`
`ServiceChargeAmount`	`getServiceChargeAmount()`
`Boolean`	`getSuppressPayment()`
`List<TaxableAmountRate>`	`getTaxableAmountRates()`
`Long`	`getTaxAmount()` Tax Amount
`Long`	`getTipAmount()` Tip Amount
`boolean`	`hasAmount()` Checks whether the 'amount' field has been set, however the value could be null
`boolean`	`hasCard()` Checks whether the 'card' field has been set, however the value could be null
`boolean`	`hasEmployeeId()` Checks whether the 'employeeId' field has been set, however the value could be null
`boolean`	`hasId()` Checks whether the 'id' field has been set, however the value could be null
`boolean`	`hasIgnorePayment()` Checks whether the 'ignorePayment' field has been set, however the value could be null
`boolean`	`hasLineItems()` Checks whether the 'lineItems' field has been set, however the value could be null
`boolean`	`hasOrderId()` Checks whether the 'orderId' field has been set, however the value could be null
`boolean`	`hasPaymentIds()` Checks whether the 'paymentIds' field has been set, however the value could be null
`boolean`	`hasServiceChargeAmount()` Checks whether the 'serviceChargeAmount' field has been set, however the value could be null
`boolean`	`hasSuppressPayment()` Checks whether the 'suppressPayment' field has been set, however the value could be null
`boolean`	`hasTaxableAmountRates()` Checks whether the 'taxableAmountRates' field has been set, however the value could be null
`boolean`	`hasTaxAmount()` Checks whether the 'taxAmount' field has been set, however the value could be null
`boolean`	`hasTipAmount()` Checks whether the 'tipAmount' field has been set, however the value could be null
`boolean`	`isNotEmptyLineItems()` Checks whether the 'lineItems' field is set and is not null and is not empty
`boolean`	`isNotEmptyPaymentIds()` Checks whether the 'paymentIds' field is set and is not null and is not empty
`boolean`	`isNotEmptyTaxableAmountRates()` Checks whether the 'taxableAmountRates' field is set and is not null and is not empty
`boolean`	`isNotNullAmount()` Checks whether the 'amount' field is set and is not null
`boolean`	`isNotNullCard()` Checks whether the 'card' field is set and is not null
`boolean`	`isNotNullEmployeeId()` Checks whether the 'employeeId' field is set and is not null
`boolean`	`isNotNullId()` Checks whether the 'id' field is set and is not null
`boolean`	`isNotNullIgnorePayment()` Checks whether the 'ignorePayment' field is set and is not null
`boolean`	`isNotNullLineItems()` Checks whether the 'lineItems' field is set and is not null
`boolean`	`isNotNullOrderId()` Checks whether the 'orderId' field is set and is not null
`boolean`	`isNotNullPaymentIds()` Checks whether the 'paymentIds' field is set and is not null
`boolean`	`isNotNullServiceChargeAmount()` Checks whether the 'serviceChargeAmount' field is set and is not null
`boolean`	`isNotNullSuppressPayment()` Checks whether the 'suppressPayment' field is set and is not null
`boolean`	`isNotNullTaxableAmountRates()` Checks whether the 'taxableAmountRates' field is set and is not null
`boolean`	`isNotNullTaxAmount()` Checks whether the 'taxAmount' field is set and is not null
`boolean`	`isNotNullTipAmount()` Checks whether the 'tipAmount' field is set and is not null
`void`	`mergeChanges(GiftCardTransaction 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.
`GiftCardTransaction`	`setAmount(Long amount)` Sets the field 'amount'.
`GiftCardTransaction`	`setCard(GiftCard card)` Sets the field 'card'.
`GiftCardTransaction`	`setEmployeeId(String employeeId)` Sets the field 'employeeId'.
`GiftCardTransaction`	`setId(String id)` Sets the field 'id'.
`GiftCardTransaction`	`setIgnorePayment(Boolean ignorePayment)` Sets the field 'ignorePayment'.
`GiftCardTransaction`	`setLineItems(List<LineItemPayment> lineItems)` Sets the field 'lineItems'.
`GiftCardTransaction`	`setOrderId(String orderId)` Sets the field 'orderId'.
`GiftCardTransaction`	`setPaymentIds(List<String> paymentIds)` Sets the field 'paymentIds'.
`GiftCardTransaction`	`setServiceChargeAmount(ServiceChargeAmount serviceChargeAmount)` Sets the field 'serviceChargeAmount'.
`GiftCardTransaction`	`setSuppressPayment(Boolean suppressPayment)` Sets the field 'suppressPayment'.
`GiftCardTransaction`	`setTaxableAmountRates(List<TaxableAmountRate> taxableAmountRates)` Sets the field 'taxableAmountRates'.
`GiftCardTransaction`	`setTaxAmount(Long taxAmount)` Sets the field 'taxAmount'.
`GiftCardTransaction`	`setTipAmount(Long tipAmount)` Sets the field 'tipAmount'.
`void`	`validate()`

Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CREATOR
```
public static final Parcelable.Creator<GiftCardTransaction> CREATOR
```
  - JSON_CREATOR
```
public static final JSONifiable.Creator<GiftCardTransaction> JSON_CREATOR
```
- Constructor Detail
  - GiftCardTransaction
```
public GiftCardTransaction()
```
    Constructs a new empty instance.
  - GiftCardTransaction
```
protected GiftCardTransaction(boolean noInit)
```
    Constructs a new empty instance.
  - GiftCardTransaction
```
public GiftCardTransaction(String json)
                    throws IllegalArgumentException
```
    Constructs a new instance from the given JSON String.
    
    Throws:
    
    IllegalArgumentException
  - GiftCardTransaction
```
public GiftCardTransaction(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.
  - GiftCardTransaction
```
public GiftCardTransaction(GiftCardTransaction 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()
```
    UUID
  - getAmount
```
public Long getAmount()
```
    Transaction Amount
  - getTaxAmount
```
public Long getTaxAmount()
```
    Tax Amount
  - getTipAmount
```
public Long getTipAmount()
```
    Tip Amount
  - getOrderId
```
public String getOrderId()
```
  - getCard
```
public GiftCard getCard()
```
    Gift Card
  - getPaymentIds
```
public List<String> getPaymentIds()
```
  - getIgnorePayment
```
public Boolean getIgnorePayment()
```
  - getServiceChargeAmount
```
public ServiceChargeAmount getServiceChargeAmount()
```
  - getTaxableAmountRates
```
public List<TaxableAmountRate> getTaxableAmountRates()
```
  - getLineItems
```
public List<LineItemPayment> getLineItems()
```
    Payments that were made for this line item
  - getEmployeeId
```
public String getEmployeeId()
```
  - getSuppressPayment
```
public Boolean getSuppressPayment()
```
  - getGenericClient
```
protected GenericClient getGenericClient()
```
    Specified by:
    
    getGenericClient in class GenericParcelable
  - 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 interface JSONifiable
  - validate
```
public void validate()
```
    Specified by:
    
    validate in interface Validator
  - isNotNullId
```
public boolean isNotNullId()
```
    Checks whether the 'id' field is set and is not null
  - isNotNullAmount
```
public boolean isNotNullAmount()
```
    Checks whether the 'amount' 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
  - isNotNullOrderId
```
public boolean isNotNullOrderId()
```
    Checks whether the 'orderId' field is set and is not null
  - isNotNullCard
```
public boolean isNotNullCard()
```
    Checks whether the 'card' field is set and is not null
  - isNotNullPaymentIds
```
public boolean isNotNullPaymentIds()
```
    Checks whether the 'paymentIds' field is set and is not null
  - isNotEmptyPaymentIds
```
public boolean isNotEmptyPaymentIds()
```
    Checks whether the 'paymentIds' field is set and is not null and is not empty
  - isNotNullIgnorePayment
```
public boolean isNotNullIgnorePayment()
```
    Checks whether the 'ignorePayment' field is set and is not null
  - isNotNullServiceChargeAmount
```
public boolean isNotNullServiceChargeAmount()
```
    Checks whether the 'serviceChargeAmount' field is set and is not null
  - isNotNullTaxableAmountRates
```
public boolean isNotNullTaxableAmountRates()
```
    Checks whether the 'taxableAmountRates' field is set and is not null
  - isNotEmptyTaxableAmountRates
```
public boolean isNotEmptyTaxableAmountRates()
```
    Checks whether the 'taxableAmountRates' field is set and is not null and is not empty
  - isNotNullLineItems
```
public boolean isNotNullLineItems()
```
    Checks whether the 'lineItems' field is set and is not null
  - isNotEmptyLineItems
```
public boolean isNotEmptyLineItems()
```
    Checks whether the 'lineItems' field is set and is not null and is not empty
  - isNotNullEmployeeId
```
public boolean isNotNullEmployeeId()
```
    Checks whether the 'employeeId' field is set and is not null
  - isNotNullSuppressPayment
```
public boolean isNotNullSuppressPayment()
```
    Checks whether the 'suppressPayment' 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
  - hasAmount
```
public boolean hasAmount()
```
    Checks whether the 'amount' 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
  - hasOrderId
```
public boolean hasOrderId()
```
    Checks whether the 'orderId' field has been set, however the value could be null
  - hasCard
```
public boolean hasCard()
```
    Checks whether the 'card' field has been set, however the value could be null
  - hasPaymentIds
```
public boolean hasPaymentIds()
```
    Checks whether the 'paymentIds' field has been set, however the value could be null
  - hasIgnorePayment
```
public boolean hasIgnorePayment()
```
    Checks whether the 'ignorePayment' 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
  - hasTaxableAmountRates
```
public boolean hasTaxableAmountRates()
```
    Checks whether the 'taxableAmountRates' field has been set, however the value could be null
  - hasLineItems
```
public boolean hasLineItems()
```
    Checks whether the 'lineItems' field has been set, however the value could be null
  - hasEmployeeId
```
public boolean hasEmployeeId()
```
    Checks whether the 'employeeId' field has been set, however the value could be null
  - hasSuppressPayment
```
public boolean hasSuppressPayment()
```
    Checks whether the 'suppressPayment' field has been set, however the value could be null
  - setId
```
public GiftCardTransaction setId(String id)
```
    Sets the field 'id'.
  - setAmount
```
public GiftCardTransaction setAmount(Long amount)
```
    Sets the field 'amount'.
  - setTaxAmount
```
public GiftCardTransaction setTaxAmount(Long taxAmount)
```
    Sets the field 'taxAmount'.
  - setTipAmount
```
public GiftCardTransaction setTipAmount(Long tipAmount)
```
    Sets the field 'tipAmount'.
  - setOrderId
```
public GiftCardTransaction setOrderId(String orderId)
```
    Sets the field 'orderId'.
  - setCard
```
public GiftCardTransaction setCard(GiftCard card)
```
    Sets the field 'card'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
  - setPaymentIds
```
public GiftCardTransaction setPaymentIds(List<String> paymentIds)
```
    Sets the field 'paymentIds'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
  - setIgnorePayment
```
public GiftCardTransaction setIgnorePayment(Boolean ignorePayment)
```
    Sets the field 'ignorePayment'.
  - setServiceChargeAmount
```
public GiftCardTransaction setServiceChargeAmount(ServiceChargeAmount serviceChargeAmount)
```
    Sets the field 'serviceChargeAmount'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
  - setTaxableAmountRates
```
public GiftCardTransaction setTaxableAmountRates(List<TaxableAmountRate> taxableAmountRates)
```
    Sets the field 'taxableAmountRates'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
  - setLineItems
```
public GiftCardTransaction setLineItems(List<LineItemPayment> lineItems)
```
    Sets the field 'lineItems'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
  - setEmployeeId
```
public GiftCardTransaction setEmployeeId(String employeeId)
```
    Sets the field 'employeeId'.
  - setSuppressPayment
```
public GiftCardTransaction setSuppressPayment(Boolean suppressPayment)
```
    Sets the field 'suppressPayment'.
  - clearId
```
public void clearId()
```
    Clears the 'id' 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
  - 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
  - clearOrderId
```
public void clearOrderId()
```
    Clears the 'orderId' field, the 'has' method for this field will now return false
  - clearCard
```
public void clearCard()
```
    Clears the 'card' field, the 'has' method for this field will now return false
  - clearPaymentIds
```
public void clearPaymentIds()
```
    Clears the 'paymentIds' field, the 'has' method for this field will now return false
  - clearIgnorePayment
```
public void clearIgnorePayment()
```
    Clears the 'ignorePayment' 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
  - clearTaxableAmountRates
```
public void clearTaxableAmountRates()
```
    Clears the 'taxableAmountRates' field, the 'has' method for this field will now return false
  - clearLineItems
```
public void clearLineItems()
```
    Clears the 'lineItems' field, the 'has' method for this field will now return false
  - clearEmployeeId
```
public void clearEmployeeId()
```
    Clears the 'employeeId' field, the 'has' method for this field will now return false
  - clearSuppressPayment
```
public void clearSuppressPayment()
```
    Clears the 'suppressPayment' 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 GiftCardTransaction copyChanges()
```
    Create a copy of this instance that contains only fields that were set after the constructor was called.
  - mergeChanges
```
public void mergeChanges(GiftCardTransaction src)
```
    Copy all the changed fields from the given source to this instance.

Class GiftCardTransaction

Fields

Nested Class Summary

Nested classes/interfaces inherited from interface com.clover.sdk.JSONifiable

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class com.clover.sdk.GenericParcelable

Methods inherited from class java.lang.Object

Field Detail

CREATOR

JSON_CREATOR

Constructor Detail

GiftCardTransaction

GiftCardTransaction

GiftCardTransaction

GiftCardTransaction

GiftCardTransaction

Method Detail

getId

getAmount

getTaxAmount

getTipAmount

getOrderId

getCard

getPaymentIds

getIgnorePayment

getServiceChargeAmount

getTaxableAmountRates

getLineItems

getEmployeeId

getSuppressPayment

getGenericClient

getJSONObject

validate

isNotNullId

isNotNullAmount

isNotNullTaxAmount

isNotNullTipAmount

isNotNullOrderId

isNotNullCard

isNotNullPaymentIds

isNotEmptyPaymentIds

isNotNullIgnorePayment

isNotNullServiceChargeAmount

isNotNullTaxableAmountRates

isNotEmptyTaxableAmountRates

isNotNullLineItems

isNotEmptyLineItems

isNotNullEmployeeId

isNotNullSuppressPayment

hasId

hasAmount

hasTaxAmount

hasTipAmount

hasOrderId

hasCard

hasPaymentIds

hasIgnorePayment

hasServiceChargeAmount

hasTaxableAmountRates

hasLineItems

hasEmployeeId

hasSuppressPayment

setId

setAmount

setTaxAmount

setTipAmount

setOrderId

setCard

setPaymentIds

setIgnorePayment

setServiceChargeAmount

setTaxableAmountRates

setLineItems

setEmployeeId

setSuppressPayment

clearId