Entidade ENDERECOS

PESSOAS.ENDERECOS

Descrição

Entidade que representa meios para contato com a respectiva pessoa. Estes endereços podem ter um significado geográfico ou apenas conceitual.
Geograficamente falando, um endereço é uma área de uma determinada dimensão.
Cada endereço pode ser dividido em sub-endereços de áreas menores que por sua vez podem ser divididos novamente.
Outros tipos de endereços, tais como telefones e endereços de e-mail, também podem ser divididos de forma hierárquica (domínios, DDI, DDD, etc.)

No resto do sistema, as entidades podem referir-se a determinados endereços mais ou menos específicos de acordo com necessidades parametrizadas.

Atributos

Atributo	Domínio	Regras	Descrição
PESSOA_ID	ID(18)	Rqd UK FK AK	Pessoa: Indica a quem este endereço se refere. Referência para PESSOAS
ID	ID(18)	Rqd PK	Identificação
SEQUENCIA	INTEGER	Rqd AK	Sequência: Número sequencial para identificar os diferentes endereços do mesmo tipo de endereço. P.ex.: Celular 1, Celular 2, Fone comercial 1, Fone comercial 2, etc. Valor padrão = 1
TIPO_ENDERECO_ID	ID(18)	Rqd UK FK AK	Tipo de endereço: Indica o tipo de endereço que este registro está informando. Ex: Endereço físico, correio eletrônico, site internet, id skype, número telefonico, etc. Referência para TIPOS_ENDERECOS
ENDERECO	TEXT	Rqd UK AK	Endereço: Depende do tipo de endereço. Pode ser o nome da rua, avenida, número de telefone, endereço de e-mail, etc.
NUMERO	UPPER	UK	Número: Número de identificação do prédio no logradouro.
COMPLEMENTO	UPPER	UK	Complemento: Complemento para o endereço (andar, apartamento, sala, etc.)
CODIGO_POSTAL	UPPER(10)		Código postal: Código de endereçamento postal (CEP no Brasil, ZIP nos EUA, etc.). O nome deste campo depende do país. A partir do CEP informado, o sistema busca os dados de logradouro, bairro e cidade. O mecanismo de busca do endereço a partir do CEP informado é definido na preferência PESSOAS.ENDERECOS.MECANISMO_BUSCA_CEP.
BAIRRO	UPPER	UK	Bairro: Nome do bairro (ou distrito) do endereço
CIDADE_ID	ID(18)	UK FK	Cidade: Cidade do endereço. Referência para CIDADES
OBSERVACOES	TEXT_LONG		Observações: Instruções adicionais com cuidados, disponibilidades ou restrições no uso deste endereço. P.ex.: Pode conter informações sobre horários ou dias em é que possível contatar a pessoa através do telefone comercial informado (tipo de contato = fone comercial).
ATIVO	FLAG(1)	Rqd	Ativo: Define se o endereço está ativo ou não. Quando inativado um endereço, o mesmo perderá todas as finalidades que até então possuía. Valor padrão = S
LATITUDE	DOUBLE(18)		Latitude: Coordenada geográfica do endereço.
LONGITUDE	DOUBLE(18)		Longitude: Coordenada geográfica do endereço.
DESCONSIDERAR_INSCRICAO_ESTADUAL	FLAG(1)	Rqd	Desconsiderar Inscrição Estadual?: Define se a Inscrição Estatual da pessoa deverá ser desconsiderada na emissão de documentos, considerando o destinatário do documento como "isenta" da inscrição ou como "consumidor final". Valor padrão = N

Regras

Atualizar a data de última atualização da pessoa

(Depois de inserir, Depois de alterar, Depois de excluir)

Atualizar a data de última atualização da pessoa

Atualizar sequencia dos endereços

(Depois de inserir, Depois de alterar, Depois de excluir)

Ao excluir ou alterar um endereço, ajusta a sequencia dos outros endereços do mesmo tipo de endereço da pessoa para que fiquem com uma sequencia correta (1, 2, 3, ...)

Aplicar a mascara no endereço

(Antes de inserir, Antes de alterar)

Caso o tipo de endereço possua mascara deve ser atualizado o endereço.

Incluir na fila de atualização GIS

(Depois de inserir, Depois de alterar)

Toda que vez que o endereço (fisico) mudar deve-se atualizar suas informações geográficas.

Atualizar e-mail usuário

(Depois de inserir, Depois de alterar)

Caso a pessoa do endereço possua um usuário associado e esse endereço seja do tipo "EMAIL", atualizar o email do usuário para o primeiro endereço do tipo "EMAIL"

Validar tipo de endereço

(Antes de inserir, Antes de alterar)

Valida se o tipo de endereço informado pode ser utilizado para o respectivo tipo de pessoa.

Retirar finalidades de endereço para endereço inativo

(Depois de inserir, Depois de alterar)

Quando inativado um endereço, as finalidades devem ser removidas.

Calcular sequencia

(Antes de inserir)

Endereços inativos devem ficar sem sequencia. Os demais, quando não informados, deve assumir o próximo número de sequencia disponível para esta pessoa e tipo de endereço.

Atualizar documentos previstos e manutenção

(Depois de inserir, Depois de alterar, Depois de excluir)

Atualizar os documentos que estão previstos e que estão em manutenção.
Somente deve ser executado se a preferencia PESSOAS.ENDERECOS.ATUALIZAR_DOCUMENTOS_MANUTENCAO_PENDENTE estiver marcada.

Endereço já cadastrado para a pessoa!

(Antes de alterar, Antes de inserir)

Quando endereço for do tipo 'eletrônico', deve permitir apenas um registro para o tipo e pessoa.

Endereço informado não está valido!

(Antes de inserir, Antes de alterar)

Validar se o endereço está dentro das definições do tipo de endereço, como tamanho mínimo e máximo especificados.

E-mail já utilizado por outro usário

(Antes de inserir, Antes de alterar)

Verifica se existem 2 ou mais usuários ATIVOS utilizando o mesmo e-mail

Endereço informado já está sendo utilizado por outra pessoa

(Antes de inserir, Antes de alterar)

O endereço informado já está sendo utilizado por outra pessoa.

Atualizar endereço principal

Quando incluído ou alterado um endereço para uma pessoa, deverá validar qual é o endereço principal da mesma. É considerado como endereço principal o endereço físico que está com sequencia um (1).

Buscar determinado endereço(pessoa_id, tipo_endereco_id, sequencia)

Método criada para substituir antigo método gerado pela UK.

Atualizar GIS

Atualiza as informações geográficas (latitude e longitude) do endereço (físico) através de chamadas ao WebService do Google Geo.

Buscar CEP(cep)

Este método pesquisa o CEP informado no parâmetro e preenche os dados da entidade com o que foi retornado na pesquisa.
O mecanismo de busca de CEP é definido na preferência PESSOAS.ENDERECOS.MECANISMO_BUSCA_CEP.
Caso seja necessário que inclua a cidade automaticamente caso o cep retorne uma cidade que não está cadastrada no sistema, altere a preferência CIDADE.CIDADES.INCLUIR_CIDADE_AUTOMATICAMENTE.

Calcular origem de operacoes(endereco)

Busca a origem a ser usada para operações entre dois endereços. Retorna:

0: Caso ambos endereços sejam do mesmo estado
1: Caso ambos endereços sejam do mesmo país
2: Caso ambos endereços sejam de países diferentes

Criar endereço físico(pessoa_id, formulario, tipo_endereco, sufixo, operacao)

Rotina utilizada para criar um endereço físico no cadastro de uma pessoa.
Pode ser utilizada a partir de qualquer interface onde as informações do endereço sejam informadas. Cadastro de pessoas, migração de dados legados, importação de pedidos, contratos, etc.

No formulário, os seguintes campos são esperados:

ENDERECO: Nome do logradouro.
NUMERO: Caso não informado, a rotina tenta extrair o número no final do logradouro.
COMPLEMENTO:
CODIGO_POSTAL:
BAIRRO:
CIDADE: Nome da cidade. Também pode ser informado com o estado no formado "CIDADE-UF", "CIDADE/UF" ou simplesmente "CIDADE UF".
ESTADO: Pode ser omitido se a cidade vier com o estado. Exemplo: SAO LEOPOLDO - RS
PAIS: Caso não informado, assume BRASIL

O retorno do método é o endereço resultante. Pode ser um endereço já cadastrado no caso das informações passadas serem iguais às informadas.

Calcular a distância entre dois endereços(origem, destino, somente_cidade)

Calcula a distância entre dois endereços retornando a distância em metros baseado no trajeto obtido através do Google.

Validar finalidade do endereço(tipo)

Retorna se o endereço possui a finalidade passada por parâmetro.

Formatar endereço da pessoa

Retorna um texto com o endereço completo da pessosa.
O texto á formatado conforme o padrão sugerido pelos correios (http://www.correios.com.br/para-voce/precisa-de-ajuda/como-enderecar-cartas-e-encomendas) utilizando o seguinte modo:

Logradouro + número + complemento (se houver)
Bairro
Cidade / Estado
País
CEP

Popular endereços físicos(campo_endereco, pessoa_id, limpar)

Rotina centralizada utilizada para popular campo onde usuário seleciona o endereço de uma pessoa.
A rotina deve receber um campo OPCAO que receberá o ID do endereço desejado.
Se a pessoa tiver vários endereços, eles serão populados com as opções na ordem.
Se tiver apenas 1 endereço, a rotina irá definir este endereço e tornar o campo read-only. Neste caso o usuário não precisa escolher um endereço.

Se o campo de endereço já tinha um valor informado e este valor não consta na lista de opções, o valor será automaticamente removido.

Note que o comportamento do campo pode variar de acordo com a opção "add-null-option". Se for "yes" e tiverem opções de endereço para serem escolhidas, será apresentado uma opção em branco e o usuário terá de escolher obrigatoriamente um endereço. Se for "no", então o primeiro endereços ficará selecionado e será utilizado caso o usuário não escolha outro.

Retornar endereços de entrega das pessoas(cliente, terceiro)

Retorna os endereços físicos definidos com a finalidade "entrega" das pessoas (cliente e destinatário do pedido).

Retornar endereços de entrega das pessoas em HTML

Retorna os endereços físicos definidos com a finalidade "entrega" das pessoas (cliente e destinatário do pedido) formatado em HTML.