To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Records one run of a recurring transaction, so the payment history of a subscription can be followed. A result is created with its start date the moment a run begins and is added to the recurring transaction's payment results; the completed date and the payment transaction are filled in once the run finishes, so a result with neither is still in flight or failed before a payment was taken.
Group: Database Entities
Implements: Serializable, Relational
Properties
| Property | Returns | Description |
|---|---|---|
| completedDate | Date | When this run finished. Null while it is still going, or if it never finished. |
| id | long | The database identifier of this run. |
| payment | PaymentTransaction | The payment taken by this run. Null while the run is still going, and also where it ended without taking a payment. |
| recurringTransaction | RecurringTransaction | The recurring transaction this run belongs to. Never null. |
| startDate | Date | When this run began, as a timestamp. Set as soon as the result is created, and it is the field runs are ordered by when the latest one is looked up. Never null. |
Methods
getId() · getPayment() · setPayment(PaymentTransaction payment) · getStartDate() · setStartDate(Date startDate) · getCompletedDate() · setCompletedDate(Date endDate) · getRecurringTransaction() · setRecurringTransaction(RecurringTransaction recurringTransaction)
getId()
Returns: long
The database identifier of this run.
getPayment()
Returns: PaymentTransaction
The payment taken by this run. Null while the run is still going, and also where it ended without taking a payment.
setPayment(PaymentTransaction payment)
Returns: void
Sets the payment taken by this run.
| Parameter | Description |
|---|---|
payment | the payment transaction produced by this run |
getStartDate()
Returns: Date
When this run began, as a timestamp. Set as soon as the result is created, and it is the field runs are ordered by when the latest one is looked up. Never null.
setStartDate(Date startDate)
Returns: void
Sets when this run began.
| Parameter | Description |
|---|---|
startDate | the date and time the run started |
getCompletedDate()
Returns: Date
When this run finished. Null while it is still going, or if it never finished.
setCompletedDate(Date endDate)
Returns: void
Sets when this run finished.
| Parameter | Description |
|---|---|
endDate | the date and time the run completed |
getRecurringTransaction()
Returns: RecurringTransaction
The recurring transaction this run belongs to. Never null.
setRecurringTransaction(RecurringTransaction recurringTransaction)
Returns: void
Sets the recurring transaction this run belongs to.
| Parameter | Description |
|---|---|
recurringTransaction | the recurring transaction that was run |
© 2025 Kademi Ltd