Package diegosneves.github.conectardoacoes.core.service

Interface ShelterServiceContract

All Known Implementing Classes:

ShelterService

public interface ShelterServiceContract

Interface ShelterServiceContract define vários métodos que manipulam um objeto Shelter. Isso inclui criar um abrigo, alterar o nome e o endereço de um abrigo, adicionar uma doação e obter detalhes de um abrigo.

Since:

1.0.0

Author:

diegoneves

Method Summary

Modifier and Type	Method	Description
void	addDonation(String shelterId, Donation donation)	Adiciona uma nova doação ao abrigo.
void	changeAddress(String shelterId, Address address)	Muda o endereço de um abrigo existente.
void	changeShelterName(String shelterId, String newName)	Muda o nome de um abrigo existente.
ShelterContract	createShelter(String shelterName, Address address, UserContract responsibleUser)	Cria um novo Shelter usando o nome do abrigo, endereço e o objeto do usuário responsável fornecidos.
List<Donation>	getDonations(String shelterId)	Busca a lista de todas as Donation de um determinado abrigo.
ShelterContract	getShelter(String shelterId)	Obtém os detalhes de um abrigo existente.

Method Details

createShelter

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

Cria um novo Shelter usando o nome do abrigo, endereço e o objeto do usuário responsável fornecidos.

Parameters:

shelterName - nome do abrigo como uma String

address - uma instância do objeto Address representando o endereço do abrigo

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

Returns:

um objeto ShelterContract do novo abrigo criado

Throws:

ShelterCreationFailureException - se um erro ocorrer durante a criação do abrigo

getShelter

ShelterContract getShelter(String shelterId)
                    throws ShelterServiceFailureException

Obtém os detalhes de um abrigo existente.

Parameters:

shelterId - ID do abrigo como uma String

Returns:

um objeto ShelterContract com detalhes do abrigo

Throws:

ShelterServiceFailureException - se um erro ocorrer durante a obtenção dos detalhes do abrigo

changeShelterName

void changeShelterName(String shelterId,
 String newName)
                throws ShelterServiceFailureException

Muda o nome de um abrigo existente.

Parameters:

shelterId - ID do abrigo como uma String

newName - o novo nome do abrigo como uma String

Throws:

ShelterServiceFailureException - se um erro ocorrer durante a alteração do nome do abrigo

changeAddress

void changeAddress(String shelterId,
 Address address)
            throws ShelterServiceFailureException

Muda o endereço de um abrigo existente.

Parameters:

shelterId - ID do abrigo como uma String

address - uma instância do objeto Address representando o novo endereço do abrigo

Throws:

ShelterServiceFailureException - se um erro ocorrer durante a alteração do endereço do abrigo

addDonation

void addDonation(String shelterId,
 Donation donation)
          throws ShelterServiceFailureException

Adiciona uma nova doação ao abrigo.

Parameters:

shelterId - ID do abrigo como uma String

donation - uma instância do objeto Donation representando a doação a ser adicionada

Throws:

ShelterServiceFailureException - se um erro ocorrer durante a adição da doação ao abrigo

getDonations

List<Donation> getDonations(String shelterId)
                     throws ShelterServiceFailureException

Busca a lista de todas as Donation de um determinado abrigo.

Parameters:

shelterId - ID do abrigo como uma String

Returns:

Uma lista de objetos Donation, que representa todas as doações recebidas pelo abrigo.

Throws:

ShelterServiceFailureException - se um erro ocorrer durante a recuperação das doações.