Class Batch

    • Constructor Detail

      • Batch

        public Batch()
        Constructs a new empty instance.
      • Batch

        protected Batch​(boolean noInit)
        Constructs a new empty instance.
      • 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
      • 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
      • 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
      • 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.