Batch (clover-android-sdk 293 API)

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

All Implemented Interfaces:

Parcelable, JSONifiable, Validator
```
public class Batch
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 Batch.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`	`Batch.Constraints`

Field Summary

Fields
Modifier and Type Field and Description

static Parcelable.Creator<Batch> CREATOR

static JSONifiable.Creator<Batch> 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<Batch>`	`CREATOR`
`static JSONifiable.Creator<Batch>`	`JSON_CREATOR`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Batch()` Constructs a new empty instance.
	`Batch(Batch src)` Constructs a new instance that is a deep copy of the source instance.
`protected`	`Batch(boolean noInit)` Constructs a new empty instance.
	`Batch(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.
	`Batch(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`	`clearBatchDetails()` Clears the 'batchDetails' field, the 'has' method for this field will now return false
`void`	`clearBatchDetailsJson()` Clears the 'batchDetailsJson' field, the 'has' method for this field will now return false
`void`	`clearBatchTransactions()` Clears the 'batchTransactions' field, the 'has' method for this field will now return false
`void`	`clearBatchType()` Clears the 'batchType' field, the 'has' method for this field will now return false
`void`	`clearCloseoutTimeDifference()` Clears the 'closeoutTimeDifference' field, the 'has' method for this field will now return false
`void`	`clearCreatedTime()` Clears the 'createdTime' field, the 'has' method for this field will now return false
`void`	`clearDevices()` Clears the 'devices' 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`	`clearModifiedTime()` Clears the 'modifiedTime' field, the 'has' method for this field will now return false
`void`	`clearRapidDepositUrl()` Clears the 'rapidDepositUrl' field, the 'has' method for this field will now return false
`void`	`clearState()` Clears the 'state' field, the 'has' method for this field will now return false
`void`	`clearTotalBatchAmount()` Clears the 'totalBatchAmount' field, the 'has' method for this field will now return false
`void`	`clearTxCount()` Clears the 'txCount' field, the 'has' method for this field will now return false
`boolean`	`containsChanges()` Returns true if this instance has any changes.
`Batch`	`copyChanges()` Create a copy of this instance that contains only fields that were set after the constructor was called.
`BatchDetail`	`getBatchDetails()` Details split based on card / employees
`String`	`getBatchDetailsJson()` Json string of COS DB batch.batch_details column
`BatchTransactions`	`getBatchTransactions()` List of payments, refunds, and gift card transaction reference objects in the batch
`BatchType`	`getBatchType()`
`Long`	`getCloseoutTimeDifference()` Time difference in minutes between expected and actual closeout
`Long`	`getCreatedTime()` Created time of batch
`String`	`getDevices()` List of devices in batch
`protected GenericClient`	`getGenericClient()`
`String`	`getId()`
`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.
`Long`	`getModifiedTime()` Modified time of batch
`String`	`getRapidDepositUrl()` URL pointing to rapid deposit i.e.
`BatchState`	`getState()`
`Long`	`getTotalBatchAmount()` Total amount closed
`Long`	`getTxCount()` The number of transactions being batched
`boolean`	`hasBatchDetails()` Checks whether the 'batchDetails' field has been set, however the value could be null
`boolean`	`hasBatchDetailsJson()` Checks whether the 'batchDetailsJson' field has been set, however the value could be null
`boolean`	`hasBatchTransactions()` Checks whether the 'batchTransactions' field has been set, however the value could be null
`boolean`	`hasBatchType()` Checks whether the 'batchType' field has been set, however the value could be null
`boolean`	`hasCloseoutTimeDifference()` Checks whether the 'closeoutTimeDifference' field has been set, however the value could be null
`boolean`	`hasCreatedTime()` Checks whether the 'createdTime' field has been set, however the value could be null
`boolean`	`hasDevices()` Checks whether the 'devices' 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`	`hasModifiedTime()` Checks whether the 'modifiedTime' field has been set, however the value could be null
`boolean`	`hasRapidDepositUrl()` Checks whether the 'rapidDepositUrl' field has been set, however the value could be null
`boolean`	`hasState()` Checks whether the 'state' field has been set, however the value could be null
`boolean`	`hasTotalBatchAmount()` Checks whether the 'totalBatchAmount' field has been set, however the value could be null
`boolean`	`hasTxCount()` Checks whether the 'txCount' field has been set, however the value could be null
`boolean`	`isNotNullBatchDetails()` Checks whether the 'batchDetails' field is set and is not null
`boolean`	`isNotNullBatchDetailsJson()` Checks whether the 'batchDetailsJson' field is set and is not null
`boolean`	`isNotNullBatchTransactions()` Checks whether the 'batchTransactions' field is set and is not null
`boolean`	`isNotNullBatchType()` Checks whether the 'batchType' field is set and is not null
`boolean`	`isNotNullCloseoutTimeDifference()` Checks whether the 'closeoutTimeDifference' field is set and is not null
`boolean`	`isNotNullCreatedTime()` Checks whether the 'createdTime' field is set and is not null
`boolean`	`isNotNullDevices()` Checks whether the 'devices' field is set and is not null
`boolean`	`isNotNullId()` Checks whether the 'id' field is set and is not null
`boolean`	`isNotNullModifiedTime()` Checks whether the 'modifiedTime' field is set and is not null
`boolean`	`isNotNullRapidDepositUrl()` Checks whether the 'rapidDepositUrl' field is set and is not null
`boolean`	`isNotNullState()` Checks whether the 'state' field is set and is not null
`boolean`	`isNotNullTotalBatchAmount()` Checks whether the 'totalBatchAmount' field is set and is not null
`boolean`	`isNotNullTxCount()` Checks whether the 'txCount' field is set and is not null
`void`	`mergeChanges(Batch 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.
`Batch`	`setBatchDetails(BatchDetail batchDetails)` Sets the field 'batchDetails'.
`Batch`	`setBatchDetailsJson(String batchDetailsJson)` Sets the field 'batchDetailsJson'.
`Batch`	`setBatchTransactions(BatchTransactions batchTransactions)` Sets the field 'batchTransactions'.
`Batch`	`setBatchType(BatchType batchType)` Sets the field 'batchType'.
`Batch`	`setCloseoutTimeDifference(Long closeoutTimeDifference)` Sets the field 'closeoutTimeDifference'.
`Batch`	`setCreatedTime(Long createdTime)` Sets the field 'createdTime'.
`Batch`	`setDevices(String devices)` Sets the field 'devices'.
`Batch`	`setId(String id)` Sets the field 'id'.
`Batch`	`setModifiedTime(Long modifiedTime)` Sets the field 'modifiedTime'.
`Batch`	`setRapidDepositUrl(String rapidDepositUrl)` Sets the field 'rapidDepositUrl'.
`Batch`	`setState(BatchState state)` Sets the field 'state'.
`Batch`	`setTotalBatchAmount(Long totalBatchAmount)` Sets the field 'totalBatchAmount'.
`Batch`	`setTxCount(Long txCount)` Sets the field 'txCount'.
`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<Batch> CREATOR
```
  - JSON_CREATOR
```
public static final JSONifiable.Creator<Batch> JSON_CREATOR
```
- Constructor Detail
  - Batch
```
public Batch()
```
    Constructs a new empty instance.
  - Batch
```
protected Batch(boolean noInit)
```
    Constructs a new empty instance.
  - Batch
```
public Batch(String json)
      throws IllegalArgumentException
```
    Constructs a new instance from the given JSON String.
    
    Throws:
    
    IllegalArgumentException
  - Batch
```
public Batch(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.
  - Batch
```
public Batch(Batch 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()
```
  - getRapidDepositUrl
```
public String getRapidDepositUrl()
```
    URL pointing to rapid deposit i.e. clover.com/dashboard.
  - getTxCount
```
public Long getTxCount()
```
    The number of transactions being batched
  - getTotalBatchAmount
```
public Long getTotalBatchAmount()
```
    Total amount closed
  - getDevices
```
public String getDevices()
```
    List of devices in batch
  - getState
```
public BatchState getState()
```
  - getBatchType
```
public BatchType getBatchType()
```
  - getCreatedTime
```
public Long getCreatedTime()
```
    Created time of batch
  - getModifiedTime
```
public Long getModifiedTime()
```
    Modified time of batch
  - getCloseoutTimeDifference
```
public Long getCloseoutTimeDifference()
```
    Time difference in minutes between expected and actual closeout
  - getBatchDetails
```
public BatchDetail getBatchDetails()
```
    Details split based on card / employees
  - getBatchTransactions
```
public BatchTransactions getBatchTransactions()
```
    List of payments, refunds, and gift card transaction reference objects in the batch
  - getBatchDetailsJson
```
public String getBatchDetailsJson()
```
    Json string of COS DB batch.batch_details column
  - 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
  - isNotNullRapidDepositUrl
```
public boolean isNotNullRapidDepositUrl()
```
    Checks whether the 'rapidDepositUrl' field is set and is not null
  - isNotNullTxCount
```
public boolean isNotNullTxCount()
```
    Checks whether the 'txCount' field is set and is not null
  - isNotNullTotalBatchAmount
```
public boolean isNotNullTotalBatchAmount()
```
    Checks whether the 'totalBatchAmount' field is set and is not null
  - isNotNullDevices
```
public boolean isNotNullDevices()
```
    Checks whether the 'devices' field is set and is not null
  - isNotNullState
```
public boolean isNotNullState()
```
    Checks whether the 'state' field is set and is not null
  - isNotNullBatchType
```
public boolean isNotNullBatchType()
```
    Checks whether the 'batchType' field is set and is not null
  - isNotNullCreatedTime
```
public boolean isNotNullCreatedTime()
```
    Checks whether the 'createdTime' field is set and is not null
  - isNotNullModifiedTime
```
public boolean isNotNullModifiedTime()
```
    Checks whether the 'modifiedTime' field is set and is not null
  - isNotNullCloseoutTimeDifference
```
public boolean isNotNullCloseoutTimeDifference()
```
    Checks whether the 'closeoutTimeDifference' field is set and is not null
  - isNotNullBatchDetails
```
public boolean isNotNullBatchDetails()
```
    Checks whether the 'batchDetails' field is set and is not null
  - isNotNullBatchTransactions
```
public boolean isNotNullBatchTransactions()
```
    Checks whether the 'batchTransactions' field is set and is not null
  - isNotNullBatchDetailsJson
```
public boolean isNotNullBatchDetailsJson()
```
    Checks whether the 'batchDetailsJson' 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
  - hasRapidDepositUrl
```
public boolean hasRapidDepositUrl()
```
    Checks whether the 'rapidDepositUrl' field has been set, however the value could be null
  - hasTxCount
```
public boolean hasTxCount()
```
    Checks whether the 'txCount' field has been set, however the value could be null
  - hasTotalBatchAmount
```
public boolean hasTotalBatchAmount()
```
    Checks whether the 'totalBatchAmount' field has been set, however the value could be null
  - hasDevices
```
public boolean hasDevices()
```
    Checks whether the 'devices' field has been set, however the value could be null
  - hasState
```
public boolean hasState()
```
    Checks whether the 'state' field has been set, however the value could be null
  - hasBatchType
```
public boolean hasBatchType()
```
    Checks whether the 'batchType' 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
  - hasModifiedTime
```
public boolean hasModifiedTime()
```
    Checks whether the 'modifiedTime' field has been set, however the value could be null
  - hasCloseoutTimeDifference
```
public boolean hasCloseoutTimeDifference()
```
    Checks whether the 'closeoutTimeDifference' field has been set, however the value could be null
  - hasBatchDetails
```
public boolean hasBatchDetails()
```
    Checks whether the 'batchDetails' field has been set, however the value could be null
  - hasBatchTransactions
```
public boolean hasBatchTransactions()
```
    Checks whether the 'batchTransactions' field has been set, however the value could be null
  - hasBatchDetailsJson
```
public boolean hasBatchDetailsJson()
```
    Checks whether the 'batchDetailsJson' field has been set, however the value could be null
  - setId
```
public Batch setId(String id)
```
    Sets the field 'id'.
  - setRapidDepositUrl
```
public Batch setRapidDepositUrl(String rapidDepositUrl)
```
    Sets the field 'rapidDepositUrl'.
  - setTxCount
```
public Batch setTxCount(Long txCount)
```
    Sets the field 'txCount'.
  - setTotalBatchAmount
```
public Batch setTotalBatchAmount(Long totalBatchAmount)
```
    Sets the field 'totalBatchAmount'.
  - setDevices
```
public Batch setDevices(String devices)
```
    Sets the field 'devices'.
  - setState
```
public Batch setState(BatchState state)
```
    Sets the field 'state'.
  - setBatchType
```
public Batch setBatchType(BatchType batchType)
```
    Sets the field 'batchType'.
  - setCreatedTime
```
public Batch setCreatedTime(Long createdTime)
```
    Sets the field 'createdTime'.
  - setModifiedTime
```
public Batch setModifiedTime(Long modifiedTime)
```
    Sets the field 'modifiedTime'.
  - setCloseoutTimeDifference
```
public Batch setCloseoutTimeDifference(Long closeoutTimeDifference)
```
    Sets the field 'closeoutTimeDifference'.
  - setBatchDetails
```
public Batch setBatchDetails(BatchDetail batchDetails)
```
    Sets the field 'batchDetails'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
  - setBatchTransactions
```
public Batch setBatchTransactions(BatchTransactions batchTransactions)
```
    Sets the field 'batchTransactions'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
  - setBatchDetailsJson
```
public Batch setBatchDetailsJson(String batchDetailsJson)
```
    Sets the field 'batchDetailsJson'.
  - clearId
```
public void clearId()
```
    Clears the 'id' field, the 'has' method for this field will now return false
  - clearRapidDepositUrl
```
public void clearRapidDepositUrl()
```
    Clears the 'rapidDepositUrl' field, the 'has' method for this field will now return false
  - clearTxCount
```
public void clearTxCount()
```
    Clears the 'txCount' field, the 'has' method for this field will now return false
  - clearTotalBatchAmount
```
public void clearTotalBatchAmount()
```
    Clears the 'totalBatchAmount' field, the 'has' method for this field will now return false
  - clearDevices
```
public void clearDevices()
```
    Clears the 'devices' field, the 'has' method for this field will now return false
  - clearState
```
public void clearState()
```
    Clears the 'state' field, the 'has' method for this field will now return false
  - clearBatchType
```
public void clearBatchType()
```
    Clears the 'batchType' 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
  - clearModifiedTime
```
public void clearModifiedTime()
```
    Clears the 'modifiedTime' field, the 'has' method for this field will now return false
  - clearCloseoutTimeDifference
```
public void clearCloseoutTimeDifference()
```
    Clears the 'closeoutTimeDifference' field, the 'has' method for this field will now return false
  - clearBatchDetails
```
public void clearBatchDetails()
```
    Clears the 'batchDetails' field, the 'has' method for this field will now return false
  - clearBatchTransactions
```
public void clearBatchTransactions()
```
    Clears the 'batchTransactions' field, the 'has' method for this field will now return false
  - clearBatchDetailsJson
```
public void clearBatchDetailsJson()
```
    Clears the 'batchDetailsJson' 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 Batch copyChanges()
```
    Create a copy of this instance that contains only fields that were set after the constructor was called.
  - mergeChanges
```
public void mergeChanges(Batch src)
```
    Copy all the changed fields from the given source to this instance.

Class Batch

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

Batch

Batch

Batch

Batch

Batch

Method Detail

getId

getRapidDepositUrl

getTxCount

getTotalBatchAmount

getDevices

getState

getBatchType

getCreatedTime

getModifiedTime

getCloseoutTimeDifference

getBatchDetails

getBatchTransactions

getBatchDetailsJson

getGenericClient

getJSONObject

validate

isNotNullId

isNotNullRapidDepositUrl

isNotNullTxCount

isNotNullTotalBatchAmount

isNotNullDevices

isNotNullState

isNotNullBatchType

isNotNullCreatedTime

isNotNullModifiedTime

isNotNullCloseoutTimeDifference

isNotNullBatchDetails

isNotNullBatchTransactions

isNotNullBatchDetailsJson

hasId

hasRapidDepositUrl

hasTxCount

hasTotalBatchAmount

hasDevices

hasState

hasBatchType

hasCreatedTime

hasModifiedTime

hasCloseoutTimeDifference

hasBatchDetails

hasBatchTransactions

hasBatchDetailsJson

setId

setRapidDepositUrl

setTxCount

setTotalBatchAmount

setDevices

setState

setBatchType

setCreatedTime

setModifiedTime

setCloseoutTimeDifference

setBatchDetails

setBatchTransactions

setBatchDetailsJson

clearId

clearRapidDepositUrl

clearTxCount

clearTotalBatchAmount