org.lightningj.paywall.paymenthandler.data

Interface PerRequestPaymentData

All Superinterfaces:

MinimalPaymentData, PaymentData

All Known Subinterfaces:

FullPaymentData

All Known Implementing Classes:

DemoFullPaymentData, DemoPerRequestPaymentData, DemoPerRequestPaymentData

public interface PerRequestPaymentData
extends MinimalPaymentData

Special interface for payment workflow that should support pay per request billing. All implementing class must also at least implement MinimalPaymentData.

Contains two fields: payPerRequest indicating if related invoice is only valid for one request and executed which is a flag set to true after a request have actually been processed (and related payment had pay per request to true) so it cannot be processed again.

See Also:

Created by Philip Vendil on 2018-12-17.

Method Summary

Modifier and Type	Method and Description
boolean	isExecuted()
boolean	isPayPerRequest()
void	setExecuted(boolean executed)
void	setPayPerRequest(boolean payPerRequest)

Methods inherited from interface org.lightningj.paywall.paymenthandler.data.MinimalPaymentData

getOrderAmount, getPreImageHash, isSettled, setOrderAmount, setPreImageHash, setSettled

Method Detail

isPayPerRequest

boolean isPayPerRequest()

Returns:

flag indicating that this payment is for one request only. The implementation can take the payPerRequest flag from the order request as guidance, but it is the PaymentHandler that ultimately decides if payPerRequest should be set.

setPayPerRequest

void setPayPerRequest(boolean payPerRequest)

Parameters:

payPerRequest - flag indicating that this payment is for one request only. The implementation can take the payPerRequest flag from the order request as guidance, but it is the PaymentHandler that ultimately decides if payPerRequest should be set.

isExecuted

boolean isExecuted()

Returns:

true if related request have been executed, is set after successful processing of a request and used to indicate that it cannot be processed again.

setExecuted

void setExecuted(boolean executed)

Parameters:

executed - true if related request have been executed, is set after successful processing if a payed call and used to indicate that it cannot be processed again.