Package com.avoka.tm.query
Class PaymentLogQuery
- java.lang.Object
-
- com.avoka.tm.query.PaymentLogQuery
-
public class PaymentLogQuery extends Object
Provides a payment log object query class.
Examples
Please find the payment log examples about list, get first and count below.
Payment Log List Example
This Groovy example shows how to list payment logs matching certain criteria.
import com.avoka.tm.query.* import com.avoka.tm.vo.* List<PaymentLog> paymentLogs = new PaymentLogQuery() .setClientCode("maguire") .setFetchLimit(150) .addOrderByDesc("id") .listValues() // In JSON format String paymentLog = new PaymentLogQuery() .setClientCode("maguire") .setFetchLimit(150) .addOrderByDesc("id") .listJson() int paymentLogCount = new PaymentLogQuery() .setClientCode("maguire") .count()
- Since:
- 19.5.0
- See Also:
PaymentLog
-
-
Constructor Summary
Constructors Constructor Description PaymentLogQuery()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PaymentLogQuery
addOrderByAsc(String orderProperty)
Add the sort order by ascending to the query.PaymentLogQuery
addOrderByDesc(String orderProperty)
Add the sort order by descending to the query.int
count()
Execute a select count query and return the total number of records selected by the query.String
firstJson()
Execute the query and return the first payment log JSON value.PaymentLog
firstValue()
Execute the query and return the first payment log value object for the query.String
listJson()
Execute the query and return a payment log JSON array list.List<PaymentLog>
listValues()
Execute the transaction query and return a list of PaymentLog value objects.PaymentLogQuery
setBatchNo(Integer drBatchNo)
Set the digital response batch number query parameter.PaymentLogQuery
setClientCode(String clientCode)
Set the client code type query parameter.PaymentLogQuery
setDoAmount(Integer doAmount)
Set the digital order amount in cents query parameter.PaymentLogQuery
setDoTimestamp(Date doTimestamp)
Set the digital order timestamp query parameter.PaymentLogQuery
setDrAmount(Integer drAmount)
Set the digital response amount query parameter.PaymentLogQuery
setDrReceiptNo(String drReceiptNo)
Set the digital response receipt number query parameter.PaymentLogQuery
setDrTimestamp(Date drTimestamp)
Set the digital response timestamp query parameter.PaymentLogQuery
setFetchLimit(int fetchLimit)
Set the query fetch limit to limit the maximum number of records returned.PaymentLogQuery
setId(Number id)
Set the payment log id (PK) query parameter.PaymentLogQuery
setMaxDoAmount(Integer maxDoAmount)
Set the max digital order amount in cents query parameter.PaymentLogQuery
setMaxDoTimestamp(Date maxDoTimestamp)
Set the max digital order timestamp query parameter.PaymentLogQuery
setMaxDrTimestamp(Date maxDrTimestamp)
Set the max digital response timestamp query parameter.PaymentLogQuery
setMinDoAmount(Integer minDoAmount)
Set the min digital order amount in cents query parameter.PaymentLogQuery
setMinDoTimestamp(Date minDoTimestamp)
Set the min digital order timestamp query parameter.PaymentLogQuery
setMinDrTimestamp(Date minDrTimestamp)
Set the min digital response timestamp query parameter.PaymentLogQuery
setPaymentLogKey(String paymentLogKey)
Set the payment log key query parameter.PaymentLogQuery
setPaymentServiceCode(String paymentServiceCode)
Set the payment service code query parameter.PaymentLogQuery
setPaymentStatus(String paymentStatus)
Set the payment status query parameter.PaymentLogQuery
setTxnId(Number txnId)
Set the txn id query parameter.PaymentLogQuery
setTxnReceiptNumber(String txnReceiptNumber)
Set the txn receipt number query parameter.PaymentLogQuery
setTxnTrackingCode(String txnTrackingCode)
Set the txn tracking code query parameter.
-
-
-
Method Detail
-
setId
public PaymentLogQuery setId(Number id)
Set the payment log id (PK) query parameter.- Parameters:
id
- the payment log id (PK) query parameter- Returns:
- the payment log query
-
setBatchNo
public PaymentLogQuery setBatchNo(Integer drBatchNo)
Set the digital response batch number query parameter.- Parameters:
drBatchNo
- the digital response batch number parameter (required)- Returns:
- the payment log query
-
setClientCode
public PaymentLogQuery setClientCode(String clientCode)
Set the client code type query parameter.- Parameters:
clientCode
- the client code parameter (required)- Returns:
- the payment log query
-
setDoAmount
public PaymentLogQuery setDoAmount(Integer doAmount)
Set the digital order amount in cents query parameter.- Parameters:
doAmount
- the digital order amount in cents query parameter (required)- Returns:
- the payment log query
-
setMaxDoAmount
public PaymentLogQuery setMaxDoAmount(Integer maxDoAmount)
Set the max digital order amount in cents query parameter.- Parameters:
maxDoAmount
- the max digital order amount in cents query parameter (required)- Returns:
- the payment log query
-
setMinDoAmount
public PaymentLogQuery setMinDoAmount(Integer minDoAmount)
Set the min digital order amount in cents query parameter.- Parameters:
minDoAmount
- the min digital order amount in cents query parameter (required)- Returns:
- the payment log query
-
setDoTimestamp
public PaymentLogQuery setDoTimestamp(Date doTimestamp)
Set the digital order timestamp query parameter.- Parameters:
doTimestamp
- the digital order timestamp query parameter (required)- Returns:
- the payment log query
-
setMaxDoTimestamp
public PaymentLogQuery setMaxDoTimestamp(Date maxDoTimestamp)
Set the max digital order timestamp query parameter.- Parameters:
maxDoTimestamp
- the max digital order timestamp query parameter (required)- Returns:
- the payment log query
-
setMinDoTimestamp
public PaymentLogQuery setMinDoTimestamp(Date minDoTimestamp)
Set the min digital order timestamp query parameter.- Parameters:
minDoTimestamp
- the min digital order timestamp query parameter (required)- Returns:
- the payment log query
-
setDrAmount
public PaymentLogQuery setDrAmount(Integer drAmount)
Set the digital response amount query parameter.- Parameters:
drAmount
- the digital response amount parameter (required)- Returns:
- the payment log query
-
setDrReceiptNo
public PaymentLogQuery setDrReceiptNo(String drReceiptNo)
Set the digital response receipt number query parameter.- Parameters:
drReceiptNo
- the digital response receipt number query parameter (required)- Returns:
- the payment log query
-
setDrTimestamp
public PaymentLogQuery setDrTimestamp(Date drTimestamp)
Set the digital response timestamp query parameter.- Parameters:
drTimestamp
- the digital response timestamp query parameter (required)- Returns:
- the payment log query
-
setMaxDrTimestamp
public PaymentLogQuery setMaxDrTimestamp(Date maxDrTimestamp)
Set the max digital response timestamp query parameter.- Parameters:
maxDrTimestamp
- the max digital response timestamp query parameter (required)- Returns:
- the payment log query
-
setMinDrTimestamp
public PaymentLogQuery setMinDrTimestamp(Date minDrTimestamp)
Set the min digital response timestamp query parameter.- Parameters:
minDrTimestamp
- the min digital response timestamp query parameter (required)- Returns:
- the payment log query
-
setPaymentServiceCode
public PaymentLogQuery setPaymentServiceCode(String paymentServiceCode)
Set the payment service code query parameter.- Parameters:
paymentServiceCode
- the payment service code parameter (required)- Returns:
- the payment log query
-
setPaymentLogKey
public PaymentLogQuery setPaymentLogKey(String paymentLogKey)
Set the payment log key query parameter.- Parameters:
paymentLogKey
- the payment log key parameter (required)- Returns:
- the payment log query
-
setPaymentStatus
public PaymentLogQuery setPaymentStatus(String paymentStatus)
Set the payment status query parameter.- Parameters:
paymentStatus
- the payment status query parameter (required)- Returns:
- the payment log query
-
setTxnId
public PaymentLogQuery setTxnId(Number txnId)
Set the txn id query parameter.- Parameters:
txnId
- the txn id query parameter (required)- Returns:
- the payment log query
-
setTxnReceiptNumber
public PaymentLogQuery setTxnReceiptNumber(String txnReceiptNumber)
Set the txn receipt number query parameter.- Parameters:
txnReceiptNumber
- the txn receipt number query parameter (required)- Returns:
- the payment log query
-
setTxnTrackingCode
public PaymentLogQuery setTxnTrackingCode(String txnTrackingCode)
Set the txn tracking code query parameter.- Parameters:
txnTrackingCode
- the txn tracking code query parameter (required)- Returns:
- the payment log query
-
setFetchLimit
public PaymentLogQuery setFetchLimit(int fetchLimit)
Set the query fetch limit to limit the maximum number of records returned. The default query fetch limit is 100 records. The maximum fetch limit is 10,000 records.- Parameters:
fetchLimit
- the query fetch limit- Returns:
- the payment log query
-
addOrderByAsc
public PaymentLogQuery addOrderByAsc(String orderProperty)
Add the sort order by ascending to the query.- Parameters:
orderProperty
- the property to sort by (required)- Returns:
- the payment log query
-
addOrderByDesc
public PaymentLogQuery addOrderByDesc(String orderProperty)
Add the sort order by descending to the query.- Parameters:
orderProperty
- the property to sort by (required)- Returns:
- the payment log query
-
count
public int count()
Execute a select count query and return the total number of records selected by the query. Does not support count queries with more than one property.- Returns:
- the total number of records selected by the query
-
listValues
public List<PaymentLog> listValues()
Execute the transaction query and return a list of PaymentLog value objects. Can result in less records returned than defined by the fetch limit.- Returns:
- execute the payment log query and return a list of PaymentLog value objects
-
listJson
public String listJson()
Execute the query and return a payment log JSON array list.- Returns:
- execute the query and return a payment log JSON array list
-
firstValue
public PaymentLog firstValue()
Execute the query and return the first payment log value object for the query.- Returns:
- execute the query and return the first payment log value object for the query
-
firstJson
public String firstJson()
Execute the query and return the first payment log JSON value.- Returns:
- execute the query and return the first payment log JSON value
-
-