Package diegosneves.github.conectardoacoes.core.service

Interface AddressServiceContract

All Known Implementing Classes:

AddressService

public interface AddressServiceContract

Esta interface define um contrato para um serviço responsável pelo gerenciamento de endereços na aplicação.

O serviço de endereço é fundamental para definir, criar e validar instâncias de Address, que representam informações de endereço em nossa aplicação. Este contrato especifica quais operações estão disponíveis para esses casos de uso.

A operação principal provida por esta interface é a criação de um novo endereço. Os componentes que utilizam este serviço devem seguir o contrato estabelecido neste interface para assegurar que eles obedecem às regras de negócio ao criar novos endereços.

Esta interface é projetada para ser utilizada com uma implementação que siga o princípio da inversão de dependência, permitindo que diferentes implementações possam ser injetadas conforme necessário sem afetar a funcionalidade geral do sistema.

Since:

1.2.0

Author:

diegoneves

Method Summary

Modifier and Type	Method	Description
Address	createAddress(String street, String number, String neighborhood, String city, String state, String zip)	Método utilizado para criar uma nova instância da classe Address.

Method Details

createAddress

Address createAddress(String street,
 String number,
 String neighborhood,
 String city,
 String state,
 String zip)
               throws AddressCreationFailureException

Método utilizado para criar uma nova instância da classe Address.

Este método recebe uma série de parâmetros que representam diferentes partes de um endereço. Ele utiliza esses parâmetros para construir uma nova instância da classe Address. A nova instância é então retornada para o código que chamou este método.

Se algum dos parâmetros estiver nulo ou em branco, este método lançará uma AddressCreationFailureException.

Parameters:

street - O nome da rua do endereço. Não deve ser nulo ou em branco.

number - O número da residência no endereço. Não deve ser nulo ou em branco.

neighborhood - O nome do bairro do endereço. Não deve ser nulo ou em branco.

city - O nome da cidade do endereço. Não deve ser nulo ou em branco.

state - O nome do estado do endereço. Não deve ser nulo ou em branco.

zip - O código postal do endereço. Não deve ser nulo ou em branco.

Returns:

Uma nova instância da classe Address contendo as informações do endereço fornecido.

Throws:

AddressCreationFailureException - Se algum dos parâmetros estiver nulo ou em branco.