Class DebitorIncomingPaymentHandler

java.lang.Object

ch.tocco.nice2.optional.debitor.impl.services.vouchercreation.DebitorIncomingPaymentHandler

All Implemented Interfaces:

IncomingPaymentHandler

@Component
public class DebitorIncomingPaymentHandler
extends Object
implements IncomingPaymentHandler

Constructor Summary

Constructors

Constructor	Description
DebitorIncomingPaymentHandler(QueryBuilderFactory queryBuilderFactory, BookIncomingPaymentService bookIncomingPaymentService)

Method Summary

Modifier and Type	Method	Description
void	clearRelevantData(Entity incomingPayment)	When the affiliation of the incoming payment changes all the previous set relations and field must be cleared
void	finalizeIncomingPayment(Entity incomingPayment, Entity debitor)	Same as IncomingPaymentHandler.finalizeIncomingPayment(Entity, String) but receives the relevant entity (e.g.
void	finalizeIncomingPayment(Entity incomingPayment, @Nullable String referenceCode)	During the reading process of the esr file this method is called to check if an entity with the passed reference code exists.
Entity	finalizeVoucher(Entity voucher, Entity incomingPayment)	Finalizes the passed voucher entity and returns it.
boolean	isRelevantRelation(String relationName)	Returns true if the passed relation name is the name of the relevant relation.
boolean	relevantRelationIsSet(Entity incomingPayment)	Returns true if the relevant relation is set on the incoming payment.
Optional<Entity>	retrieveOrder(String referenceCode)
Optional<Entity>	retrieveOrderDirect(String referenceCode)
Optional<Entity>	retrieveOrderScor(String referenceCode)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DebitorIncomingPaymentHandler

public DebitorIncomingPaymentHandler(QueryBuilderFactory queryBuilderFactory,
 @Lazy
 BookIncomingPaymentService bookIncomingPaymentService)

Method Details

relevantRelationIsSet

public boolean relevantRelationIsSet(Entity incomingPayment)

Description copied from interface: IncomingPaymentHandler

Returns true if the relevant relation is set on the incoming payment. The relevant relation is equal to the source of payment (e.g. relDebitor for orders, relDonation for donations).

Specified by:

relevantRelationIsSet in interface IncomingPaymentHandler

isRelevantRelation

public boolean isRelevantRelation(String relationName)

Description copied from interface: IncomingPaymentHandler

Returns true if the passed relation name is the name of the relevant relation. The relevant relation is equal to the source of payment (e.g. relDebitor for orders, relDonation for donations).

Specified by:

isRelevantRelation in interface IncomingPaymentHandler

finalizeVoucher

public Entity finalizeVoucher(Entity voucher,
 Entity incomingPayment)

Description copied from interface: IncomingPaymentHandler

Finalizes the passed voucher entity and returns it. Needs to

 - set the relation relDebit_account
 - set the relation relCredit_account
 - set the relation relCurrency
 - set the specific relation which is checked in the IncomingPaymentHandler.relevantRelationIsSet(Entity) method
 

Specified by:

finalizeVoucher in interface IncomingPaymentHandler

finalizeIncomingPayment

public void finalizeIncomingPayment(Entity incomingPayment,
 @Nullable
 @Nullable String referenceCode)

Description copied from interface: IncomingPaymentHandler

During the reading process of the esr file this method is called to check if an entity with the passed reference code exists. If so, the entity will be set on the incoming payment (e.g. relDebitor or relDonation). Additionally, a handler can set some more entity-specific data.

Specified by:

finalizeIncomingPayment in interface IncomingPaymentHandler

retrieveOrder

public Optional<Entity> retrieveOrder(String referenceCode)

retrieveOrderScor

public Optional<Entity> retrieveOrderScor(String referenceCode)

retrieveOrderDirect

public Optional<Entity> retrieveOrderDirect(String referenceCode)

finalizeIncomingPayment

public void finalizeIncomingPayment(Entity incomingPayment,
 Entity debitor)

Description copied from interface: IncomingPaymentHandler

Same as IncomingPaymentHandler.finalizeIncomingPayment(Entity, String) but receives the relevant entity (e.g. Debitor, Donation) as second argument. This method is used if a relevant relation is set on an existing incoming payment entity.

Specified by:

finalizeIncomingPayment in interface IncomingPaymentHandler

clearRelevantData

public void clearRelevantData(Entity incomingPayment)

Description copied from interface: IncomingPaymentHandler

When the affiliation of the incoming payment changes all the previous set relations and field must be cleared

Specified by:

clearRelevantData in interface IncomingPaymentHandler