Package com.avoka.fc.core.dao

Class PaymentLogDao

java.lang.Object
com.avoka.core.dao.BaseDao
com.avoka.fc.core.dao.AbstractDao
com.avoka.fc.core.dao.PaymentLogDao
public class PaymentLogDao extends AbstractDao
Provides a DAO for the PaymentLog entity.
See Also:

  • Constructor Details

    • PaymentLogDao

      public PaymentLogDao()

  • Method Details

    • getPaymentLogById

      public PaymentLog getPaymentLogById(Object id)
      Return the payment log with the specified OID
      Parameters:
      id - the OID
      Returns:
      the matching payment log, or null if not found

    • getByPaymentLogKey

      public PaymentLog getByPaymentLogKey(String paymentLogKey)
      Return the payment log for the specified payment log key
      Parameters:
      paymentLogKey - the payment log key
      Returns:
      the payment log entity
      Since:
      4.0.0

    • getLatestPaymentId

      public String getLatestPaymentId(String submissionId)
      Return the OID of the most recent payment log for a submission
      Parameters:
      submissionId - the valid OID of a submission
      Returns:
      the OID of the most recent payment log for the submission

    • getLatestPaymentLog

      public PaymentLog getLatestPaymentLog(Submission submission)
      Return the latest PaymentLog for the given submission
      Parameters:
      submission - the submission record (required)
      Returns:
      the latest PaymentLog for the given submission
      Since:
      4.0.0

    • getLatestCreatedPaymentId

      public String getLatestCreatedPaymentId(String submissionId)
      Return the OID of the most recent created payment log for a submission
      Parameters:
      submissionId - the valid OID of a submission
      Returns:
      the OID of the most recently created payment log for the submission

    • getLatestCompletedPaymentId

      public String getLatestCompletedPaymentId(String submissionId)
      Return the OID of the most recent completed payment log for a submission
      Parameters:
      submissionId - the valid OID of a submission
      Returns:
      the OID of the most recently created payment log for the submission

    • getLatestCompletedPayment

      public PaymentLog getLatestCompletedPayment(Submission submission)
      Return latest completed payment log for a submission
      Parameters:
      submission - the submission record (required)
      Returns:
      latest completed payment log for a submission
      Since:
      5.0.0

    • getPaymentLogList

      public List<PaymentLog> getPaymentLogList(String clientId, String paymentIdentifier, String formReceiptNo, Object drTransactionNo, String serviceCode, Integer paymentAmountMinCents, Integer paymentAmountMaxCents, Date startDate, Date endDate)
      Return the list of payment log records for the specified search criteria
      Parameters:
      clientId - the OID of the client associated with the payment log (optional)
      paymentIdentifier - the OID of the payment log or the payment key (optional)
      formReceiptNo - the receipt number of the submission (optional)
      drTransactionNo - the transaction number or receipt number returned by the payment gateway (optional)
      serviceCode - the payment service code (optional)
      paymentAmountMinCents - the minimum payment amount in cents (optional)
      paymentAmountMaxCents - the maximum payment amount in cents (optional)
      startDate - the lower bound on the digital order timestamp (optional)
      endDate - the upper bound on the digital order timestamp (optional)
      Returns:
      the list of matching payment logs

    • getOutstandingTransactions

      public List<PaymentLog> getOutstandingTransactions(int timeout, String serviceDefinitionCode)
      Return all payment log entries that have not received a response, where the request is older than a specified number of minutes
      Parameters:
      timeout - the maximum request age in minutes, above which payment logs are considered outstanding
      serviceDefinitionCode - the payment service code to search for (optional)
      Returns:
      the list of matching payment logs

    • getTransactionsByBatchNo

      public List<PaymentLog> getTransactionsByBatchNo(String batchNo, Client client, String serviceDefinitionCode)
      Return payment log entries for the specified batch, client and payment service
      Parameters:
      batchNo - the batch number to search for
      serviceDefinitionCode - the payment service code to search for (optional)
      client - the Client to restrict the search to (optional)
      Returns:
      the list of matching payment logs
      Since:
      4.0.0