Package diegosneves.github.conectardoacoes.core.service

Interface DonationServiceContract

All Known Implementing Classes:
DonationService
public interface DonationServiceContract
Interface DonationServiceContract define um contrato para a criação de doações.

Uma doação é caracterizada por sua descrição e a quantidade (amount).

As classes que implementam essa interface são responsáveis por definir a lógica de negócios para atender aos requisitos deste contrato.

As classes que implementam essa interface devem gerenciar eventuais exceções, garantindo que as doações sejam criadas somente quando os dados estiverem de acordo com as regras definidas.

Since:
1.2.0
Author:
diegoneves
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Donation
    createDonation(String description, Integer amount)
    Cria um objeto de doação com uma descrição e quantidade dada.

  • Method Details

    • createDonation

      Donation createDonation(String description, Integer amount) throws DonationRegisterFailureException
      Cria um objeto de doação com uma descrição e quantidade dada.

      Este método tenta criar um objeto Donation com base nos parâmetros de descrição e quantidade fornecidos pelo usuário. A operação pode falhar e, consequentemente, lançar uma exceção em dois cenários:

      • Descrição: quando a descrição fornecida é nula ou uma string vazia.
      • Quantidade: quando a quantidade fornecida é nula.
      Parameters:
      description - Deve ser uma string contendo a descrição da doação. Não pode ser nula ou vazia.
      amount - Deve ser um número inteiro maior que zero representando a quantidade de doação. Não pode ser nulo.
      Returns:
      Uma instância do objeto Donation se a operação for bem-sucedida.
      Throws:
      DonationRegisterFailureException - Se a criação da doação falhar devido a argumentos inválidos (veja os detalhes acima).