Fuente de Datos de Pago

package com.iconsolutions.ipf.core.releaser.loader;

import com.iconsolutions.ipf.core.shared.domain.context.ProcessingEntity;
import com.iconsolutions.ipf.core.shared.domain.context.UnitOfWorkId;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import reactor.util.annotation.Nullable;

import java.util.Optional;

public interface PaymentDataSource<INIT, INSTR, TRANS> {

    /**
     * Gets a parent Payment Initiation Mono for the provided unitOfWorkId, if any, empty Mono otherwise
     * This is wrapped in an Optional to allow for scenarios where the Initiation is not required, and then an empty Optional can be returned
     *
     * @param unitOfWorkId unitOfWorkId
     * @param processingEntity denotes the ProcessingEntity the requestor has permission to access.
     * @return Mono with Payment Instruction of type I, or an empty Mono
     */
    Mono<Optional<INIT>> getPaymentInitiation(UnitOfWorkId unitOfWorkId, @Nullable ProcessingEntity processingEntity);


    /**
     * Gets a Payment Instruction Mono for the provided unitOfWorkId, if any, empty Mono otherwise
     *
     * @param unitOfWorkId unitOfWorkId
     * @param processingEntity denotes the ProcessingEntity the requestor has permission to access.
     * @return Mono with Payment Instruction of type I, or an empty Mono
     */
    Mono<INSTR> getPaymentInstruction(UnitOfWorkId unitOfWorkId, @Nullable ProcessingEntity processingEntity);

    /**
     * Gets a Flux of all payment instructions related to instruction unitOfWorkId provided,
     * with an optional offset as a starting point.
     *
     * @param unitOfWorkId of related payment instruction
     * @param processingEntity denotes the ProcessingEntity the requestor has permission to access.
     * @param offset optional unitOfWorkId of the last related transaction being already released
     * @return Flux of Payment Transaction objects
     */
    Flux<TRANS> getPaymentTransactions(UnitOfWorkId unitOfWorkId, @Nullable ProcessingEntity processingEntity, Optional<UnitOfWorkId> offset);

    /**
     * Gets a Mono of the Payment Transaction for the specific unitOfWorkId provided.
     *
     * @param unitOfWorkId of payment transaction
     * @param processingEntity denotes the ProcessingEntity the requestor has permission to access.
     * @return Mono of Payment Transaction object
     */
    Mono<TRANS> getPaymentTransaction(UnitOfWorkId unitOfWorkId, @Nullable ProcessingEntity processingEntity);

    /**
     * Marks the instruction as fully released and enables any necessary clean-up operations.
     *
     * @param instructionUnitOfWorkId the unitOfWorkId of the payment instruction to be marked as 'done' (or released)
     * @return a Mono<Void> that completes when the marking process has been successfully executed
     */
    Mono<Void> markAsDone(UnitOfWorkId instructionUnitOfWorkId);

}