Package diegosneves.github.conectardoacoes.core.service

Class ShelterService

java.lang.Object

diegosneves.github.conectardoacoes.core.service.ShelterService

All Implemented Interfaces:

ShelterServiceContract

public class ShelterService
extends Object
implements ShelterServiceContract

A classe de serviço ShelterService é responsável pelas operações de negócios relacionadas a abrigos. Essas operações incluem criação de abrigos, busca por abrigos e alterações nos atributos dos abrigos. Esta classe implementa a interface ShelterServiceContract.

Since:

1.0.0

Author:

diegoneves

See Also:

• ShelterServiceContract
• ShelterContractRepository

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DONATION_REQUIRED_ERROR_MESSAGE
static final String	ERROR_MESSAGE_ADDRESS_NULL
static final String	INVALID_SHELTER_ID_MESSAGE
static final String	INVALID_SHELTER_NAME_ERROR_MESSAGE
private final ShelterContractRepository	shelterContractRepository

Constructor Summary

Constructors

Constructor	Description
ShelterService(ShelterContractRepository shelterContractRepository)

Method Summary

Modifier and Type	Method	Description
void	addDonation(String shelterId, Donation donation)	Este método é responsável por adicionar uma Donation a um ShelterContract específico, identificado por seu id.
void	changeAddress(String shelterId, Address address)	Este método é usado para alterar o endereço do abrigo identificado pelo ID fornecido.
void	changeShelterName(String shelterId, String newName)	Este método é usado para alterar o nome do abrigo identificado pelo ID fornecido.
ShelterContract	createShelter(String shelterName, Address address, UserContract responsibleUser)	Este método cria um novo ShelterContract utilizando ShelterFactory.create(java.lang.String, diegosneves.github.conectardoacoes.core.domain.shelter.entity.value.Address, diegosneves.github.conectardoacoes.core.domain.user.entity.UserContract).
List<Donation>	getDonations(String shelterId)	Este método é responsável por recuperar a lista de Donation de um ShelterContract específico, identificado por seu id.
ShelterContract	getShelter(String shelterId)	Retorna um objeto ShelterContract baseado no ID do abrigo fornecido.
private static void	validateShelterId(String shelterId)	Valida o ID do abrigo fornecido.

Methods inherited from class java.lang.Object

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

Field Details

INVALID_SHELTER_ID_MESSAGE

public static final String INVALID_SHELTER_ID_MESSAGE

See Also:

• Constant Field Values

INVALID_SHELTER_NAME_ERROR_MESSAGE

public static final String INVALID_SHELTER_NAME_ERROR_MESSAGE

See Also:

• Constant Field Values

ERROR_MESSAGE_ADDRESS_NULL

public static final String ERROR_MESSAGE_ADDRESS_NULL

See Also:

• Constant Field Values

DONATION_REQUIRED_ERROR_MESSAGE

public static final String DONATION_REQUIRED_ERROR_MESSAGE

See Also:

• Constant Field Values

shelterContractRepository

private final ShelterContractRepository shelterContractRepository

Constructor Details

ShelterService

public ShelterService(ShelterContractRepository shelterContractRepository)

Method Details

createShelter

public ShelterContract createShelter(String shelterName,
 Address address,
 UserContract responsibleUser)
                              throws ShelterCreationFailureException

Este método cria um novo ShelterContract utilizando ShelterFactory.create(java.lang.String, diegosneves.github.conectardoacoes.core.domain.shelter.entity.value.Address, diegosneves.github.conectardoacoes.core.domain.user.entity.UserContract). O novo objeto Shelter é salvo usando o método RepositoryContract.persist(T).

Specified by:

createShelter in interface ShelterServiceContract

Parameters:

shelterName - O nome do abrigo como uma string.

address - uma instancia do objeto Address representando o endereço do abrigo

responsibleUser - um objeto UserContract representando o usuário responsável pelo abrigo

Returns:

um novo objeto ShelterContract

Throws:

ShelterCreationFailureException - quando uma falha ocorre durante a criação do ShelterContract

See Also:

• ShelterFactory
• ShelterContractRepository

getShelter

public ShelterContract getShelter(String shelterId)
                           throws ShelterServiceFailureException

Retorna um objeto ShelterContract baseado no ID do abrigo fornecido.

Specified by:

getShelter in interface ShelterServiceContract

Parameters:

shelterId - O ID do abrigo como uma string.

Returns:

um objeto ShelterContract que corresponde ao ID do abrigo fornecido

Throws:

ShelterServiceFailureException - quando uma falha ocorre durante a busca pelo abrigo

validateShelterId

private static void validateShelterId(String shelterId)
                               throws ShelterServiceFailureException

Valida o ID do abrigo fornecido. Primeiro, verifica se o ID do abrigo é nulo ou vazio usando ValidationUtils.validateNotNullOrEmpty(T, java.lang.Integer, java.lang.Class<? extends java.lang.RuntimeException>). Em seguida, tenta verificar se o ID do abrigo é um UUID válido usando UuidUtils.isValidUUID(java.lang.String). Se qualquer uma dessas verificações falhar, ele lançará uma ShelterServiceFailureException com uma mensagem que indica que o ID do abrigo fornecido é inválido.

Parameters:

shelterId - O ID do abrigo a ser validado.

Throws:

ShelterServiceFailureException - Se o ID do abrigo fornecido for nulo, vazio ou não for um UUID válido.

changeShelterName

public void changeShelterName(String shelterId,
 String newName)
                       throws ShelterServiceFailureException

Este método é usado para alterar o nome do abrigo identificado pelo ID fornecido.

Primeiro, o método valida se o novo nome não é nulo nem vazio usando ValidationUtils.validateNotNullOrEmpty(T, java.lang.Integer, java.lang.Class<? extends java.lang.RuntimeException>). Se a validação falhar, uma ShelterServiceFailureException é lançada com uma mensagem indicando que o novo nome do abrigo é inválido.

O nome do abrigo recuperado é então alterado para o novo nome fornecido usando o método ShelterContract.changeShelterName(java.lang.String).

Finalmente, o abrigo com o nome atualizado é salvo no repositório usando RepositoryContract.persist(T).

Specified by:

changeShelterName in interface ShelterServiceContract

Parameters:

shelterId - O ID do abrigo cujo nome será alterado. Deve ser uma identificação válida de um abrigo existente.

newName - O novo nome para o abrigo. Ele não pode ser null ou uma String vazia.

Throws:

ShelterServiceFailureException - Se o novo nome do abrigo fornecido for inválido (ou seja, nulo ou vazio), ou se ocorrer um problema ao recuperar o abrigo com o ID fornecido ou ao salvar o abrigo com o nome alterado.

changeAddress

public void changeAddress(String shelterId,
 Address address)
                   throws ShelterServiceFailureException

Este método é usado para alterar o endereço do abrigo identificado pelo ID fornecido.

Primeiro, o método valida se o novo endereço não é nulo usando ValidationUtils.validateNotNullOrEmpty(T, java.lang.Integer, java.lang.Class<? extends java.lang.RuntimeException>). Se a validação falhar, uma ShelterServiceFailureException é lançada com uma mensagem indicando que o novo endereço do abrigo é inválido.

O endereço do abrigo recuperado é então alterado para o novo endereço fornecido usando o método ShelterContract.changeAddress(diegosneves.github.conectardoacoes.core.domain.shelter.entity.value.Address).

Finalmente, o abrigo com o endereço atualizado é salvo no repositório usando RepositoryContract.persist(T).

Specified by:

changeAddress in interface ShelterServiceContract

Parameters:

shelterId - O ID do abrigo cujo endereço será alterado. Deve ser uma identificação válida de um abrigo existente.

address - O novo endereço para o abrigo. Ele não pode ser null ou uma instância inválida de Address.

Throws:

ShelterServiceFailureException - Se o novo endereço do abrigo fornecido for inválido (ou seja, null ou instância inválida), ou se ocorrer um problema ao recuperar o abrigo com o ID fornecido ou ao salvar o abrigo com o endereço alterado.

addDonation

public void addDonation(String shelterId,
 Donation donation)
                 throws ShelterServiceFailureException

Este método é responsável por adicionar uma Donation a um ShelterContract específico, identificado por seu id.

Primeiro, ele confirma que o objeto Donation não é nulo usando ValidationUtils.validateNotNullOrEmpty(T, java.lang.Integer, java.lang.Class<? extends java.lang.RuntimeException>). Se este objeto Donation for nulo, ele lança uma ShelterServiceFailureException.

Em seguida, ele usa o id do abrigo fornecido para obter o ShelterContract correspondente. Este ShelterContract é então atualizado adicionando a Donation fornecida.

Finalmente, o ShelterContract atualizado é salvo no repositorio usando RepositoryContract.persist(T).

Specified by:

addDonation in interface ShelterServiceContract

Parameters:

shelterId - O ID do abrigo ao qual a doação será adicionada. Deve ser uma identificação válida de um abrigo existente.

donation - Uma instancia do objeto Donation representando a doação a ser adicionada.

Throws:

ShelterServiceFailureException - Se a doação fornecida for inválida (ou seja, nula ou vazia), ou se ocorrer um problema ao recuperar o abrigo com o ID fornecido ou ao salvar o abrigo com a doação adicionada.

getDonations

public List<Donation> getDonations(String shelterId)
                            throws ShelterServiceFailureException

Este método é responsável por recuperar a lista de Donation de um ShelterContract específico, identificado por seu id.

Primeiro, ele usa o id do abrigo fornecido para obter o ShelterContract correspondente. A lista de Donation deste ShelterContract específico é então retornada.

Note que este método pode lançar uma ShelterServiceFailureException. Isto ocorrerá se houver um problema ao tentar recuperar o ShelterContract com o id fornecido.

Specified by:

getDonations in interface ShelterServiceContract

Parameters:

shelterId - O ID do abrigo do qual as doações serão recuperadas. Deve ser uma identificação válida de um abrigo existente.

Returns:

Uma lista de Donation que foram feitas para o abrigo identificado pelo id fornecido.

Throws:

ShelterServiceFailureException - Se ocorrer um problema ao tentar recuperar o ShelterContract com o id fornecido.