Person - Histórico de revisão

Rodrigogml: /* Conta Bancária (PersonBankAccountVO) */

2025-03-13T16:09:48Z

Conta Bancária (PersonBankAccountVO)

← Edição anterior		Edição das 16h09min de 13 de março de 2025
Linha 46:		Linha 46:
	* '''account ''[Obrigatório]''''' - Número da conta.		* '''account ''[Obrigatório]''''' - Número da conta.
	* '''accountDV ''[Obrigatório]''''' - Dígito Verificacor da conta informada. Utilizado pela maioria dos bancos, e em geral é requierido ao se realizar transferências.		* '''accountDV ''[Obrigatório]''''' - Dígito Verificacor da conta informada. Utilizado pela maioria dos bancos, e em geral é requierido ao se realizar transferências.
	* '''flags''' - Lista de 'marcadores' que podem ser definidos na conta para ajudar os módulos a tratar a conta. As marcações existentes são:		* '''flags''' - Lista de 'marcadores' que podem ser definidos na conta para ajudar os módulos a tratar a conta. '''Cada flag pode ser definida em nenhum ou múltiplas contas simultâneamente''' cabe a cada módulo pesquisar as contas com as flags e decidir como tratar as multiplas marcações. As marcações existentes são:
	*: <code>SALARY</code> - Índica que é a conta pode ser utilizada para pagamento de salário.		*: <code>SALARY</code> - Índica que é a conta pode ser utilizada para pagamento de salário.

Rodrigogml: /* Conta Bancária (PersonBankAccountVO) */

2025-03-13T15:18:41Z

Conta Bancária (PersonBankAccountVO)

← Edição anterior		Edição das 15h18min de 13 de março de 2025
Linha 36:		Linha 36:

	* '''label''' - Permite que o usuário defina um rótulo identificador sobre essa conta para facilitar sua organização.		* '''label''' - Permite que o usuário defina um rótulo identificador sobre essa conta para facilitar sua organização.
	* '''accountType ´´[Obrigatório]''''' - Enumeration indicando o tipo da conta:		* '''accountType ''[Obrigatório]''''' - Enumeration indicando o tipo da conta:
	*: <CODE>CHECKING</code> - Conta Corrente		*: <CODE>CHECKING</code> - Conta Corrente
	*: <CODE>SAVINGS</code> - Poupança		*: <CODE>SAVINGS</code> - Poupança

Rodrigogml: /* BIS10 */

2025-03-13T15:18:21Z

BIS10

← Edição anterior		Edição das 15h18min de 13 de março de 2025
Linha 3:		Linha 3:
	= BIS10 =		= BIS10 =

			O módulo Person faz parte do Kernel e tem a finalidade de centralizar o cadastro de pessoas físicas e jurídicas para todos os módulos. Indepentende da utilização pelos outros módulos, o módulo Person deve ser capaz de armazenas as mais diversas informações das pessoas, e deve expandir a medida que outros módulos solicitem, '''sem criar dependências externas nem obrigatoriedade de preenchimento de campos além do básico'''. Em outras palavras, não se pode transferir a obrigatoriedade de dados dos campos para dentro do módulo Person.

			== Pessoa (PersonVO) ==

			O objeto principal que representa uma pessoa é o PersonVO. Este objeto carrega os atributos diretos e únicos de PersonVO, por exemplo:

			* '''type ''[Obrigatório]''''' - Enumeration que define o Tipo de pessoa cadastrada:
			*: <code>PERSONAL</code> - Indica uma pessoa física cadastradas no sistema (utilizada apenas para pessoas/civís/humanos!!!);
			*: <code>CORPORATION</code> - Indica uma pessoa jurídica, instituição, organização, etc.. Qualquer tipo de instituição representativa que não seja uma pessoa física.
			* '''displayName ''[Obrigatório/Unico]''''' - Nome como a pessoa é exibida no sistema, útil para busca ou para conter nomes que o usuário identifique ou se lembre sobre a pessoa.
			* '''cpfCnpj ''[Obrigatório]''''' - Documento da pessoa, CPF para PF e CNPJ para PJ.
			* '''fullName''' - Nome completo (PF) ou Razão Social (PJ).
			* '''companyName''' - Nome fantasia (PJ) ou apelido (PF).
			* ''Outros campos descritos no JavaDoc''


			{{nota\|Instituições sem CNPJ\|Em alguns casos se faz necessário identificar instituições que não tem um CNPJ direto. Por exemplo, identificação do beneficiário de uma guia de pagamento de tributos estaduais ou federais, pagas por chave pix ou código de barras.

			Neste casos se convencionou a cadastrar a Pessoa Jurídica com algum CNPJ válido que não tenha no sistema. que não dê conflito com outras empresas, uma estratégia pode ser utilizar o CNPJ do Banco do Brasil, com os códigos de filiais em 9999, 9998, etc.. Exemplos:
			* '''CNPJ da Matriz do BB''': 00.000.000/0001-91 '''(não utilizar para evitar conflito com o Banco do Brasil.'''
			* '''CNPJ da Filial 9999''': 00.000.000/9999-62
			* '''CNPJ da Filial 9998''': 00.000.000/9998-81
			* '''CNPJ da Filial 9997''': 00.000.000/9997-09
			* '''CNPJ da Filial 9996''': 00.000.000/9996-10
			* '''CNPJ da Filial 9995''': 00.000.000/9995-39
			}}


			=== Conta Bancária (PersonBankAccountVO) ===

			Objeto com relação N:1 com PersonVO, responsável por armazenar informações de contas bancárias da Pessoa. Útil para realizaçãod e pagamentos, validação de recebimentos, informações e consultas cadastrais, etc.

			* '''label''' - Permite que o usuário defina um rótulo identificador sobre essa conta para facilitar sua organização.
			* '''accountType ´´[Obrigatório]''''' - Enumeration indicando o tipo da conta:
			*: <CODE>CHECKING</code> - Conta Corrente
			*: <CODE>SAVINGS</code> - Poupança
			*: <CODE>INVESTMENT</code> - Conta de Investimentos
			*: <CODE>SALARY</code> - Conta Salário
			* '''bankVO ''[Obrigatório]''''' - Relaciona o banco de origem da conta representada por este objeto.
			* '''agency ''[Obrigatório]''''' - Número da agência da conta.
			* '''agencyDV''' - Dígito verificador da agência. Normalmente não utilizado pelos bancos, mas alguns, com o BB, utiliza.
			* '''account ''[Obrigatório]''''' - Número da conta.
			* '''accountDV ''[Obrigatório]''''' - Dígito Verificacor da conta informada. Utilizado pela maioria dos bancos, e em geral é requierido ao se realizar transferências.
			* '''flags''' - Lista de 'marcadores' que podem ser definidos na conta para ajudar os módulos a tratar a conta. As marcações existentes são:
			*: <code>SALARY</code> - Índica que é a conta pode ser utilizada para pagamento de salário.


			{{TODO\|Em alguns lugares é previsto que haja o DV para agência, para o número da conta e um terceiro para o número da agência e conta.

			Esse objeto não tem essa previsão, e em algum momento podemos precisar desse terceiro DV. Acredito que seja necessário em contas da CEF. Ao implementar o campo para guardar esse terceiro DV é preciso estudar se o DV que a maioria das contas utiliza (e que já é guardado neste objeto) é o DV da conta corrente isolado ou o do conjunto agência + conta, e realizar a implementação correta mantendo a compatibilidade com o código já existente.}}

	= BIS2 =		= BIS2 =

Rodrigogml em 14h34min de 13 de março de 2025

2025-03-13T14:34:32Z

← Edição anterior		Edição das 14h34min de 13 de março de 2025
Linha 6:		Linha 6:


	== BIS2 ==
			= BIS2 =


Linha 13:		Linha 14:
	Em sua primeira versão, Person começa oferecendo um conjunto de campos para cada tipo de pessoa. Em versões futuras novos campos deverão ser oferecidos para centralizar o máximo de informações possíveis.		Em sua primeira versão, Person começa oferecendo um conjunto de campos para cada tipo de pessoa. Em versões futuras novos campos deverão ser oferecidos para centralizar o máximo de informações possíveis.

	=== Estrutura ===		== Estrutura ==

	O serviço oferece o objecto PersonVO para representar cada pessoa. Dentro de PersonVO há dois outros objetos:		O serviço oferece o objecto PersonVO para representar cada pessoa. Dentro de PersonVO há dois outros objetos:
Linha 25:		Linha 26:


	=== Funcionamento e Usabilidade ===		== Funcionamento e Usabilidade ==

	O sistema não permitirá duas pessoas cadastradas com o Mesmo CPF/CNPJ, no entanto, permitirá que se cadastre uma pessoa sem o CPF ou CNPJ. Por isso, é recomendável que antes de associar um PersonVO novo em um determinado objeto, é aconselhável verificar se não existe ainda um Person com aquele CPF/CNPJ. Neste caso é aconselhável associar o objeto já existente. Como implementar essa usabilidade na UI do usuário deve ser definida na documentação de cada tipo de UI.		O sistema não permitirá duas pessoas cadastradas com o Mesmo CPF/CNPJ, no entanto, permitirá que se cadastre uma pessoa sem o CPF ou CNPJ. Por isso, é recomendável que antes de associar um PersonVO novo em um determinado objeto, é aconselhável verificar se não existe ainda um Person com aquele CPF/CNPJ. Neste caso é aconselhável associar o objeto já existente. Como implementar essa usabilidade na UI do usuário deve ser definida na documentação de cada tipo de UI.

	==== Funcionamento do Endereço ====		=== Funcionamento do Endereço ===

	O Person utiliza o serviço de Location para cadastrar um endereço. Caso o CEP seja preenchido, o sistema verificará se o CEP é conhecido pelo Location, e em caso positivo, copiará as informações do Location por cima de qualquer informação definida no PersonAddressVO. Mantendo inalterado apenas campos adicionais como Número e Complemento. Caso o CEP não seja conhecido, ele não será cadastrado no serviço de Location, mas será permitido que o usuário utilize o endereço digitado manualmente (Sem associação com o LocationAddress).		O Person utiliza o serviço de Location para cadastrar um endereço. Caso o CEP seja preenchido, o sistema verificará se o CEP é conhecido pelo Location, e em caso positivo, copiará as informações do Location por cima de qualquer informação definida no PersonAddressVO. Mantendo inalterado apenas campos adicionais como Número e Complemento. Caso o CEP não seja conhecido, ele não será cadastrado no serviço de Location, mas será permitido que o usuário utilize o endereço digitado manualmente (Sem associação com o LocationAddress).

	=== Campos ===		== Campos ==

	Aqui estão relacionados os campos atuais dos objetos, sua finalidades e requisitos:		Aqui estão relacionados os campos atuais dos objetos, sua finalidades e requisitos:

	==== PersonVO ====		=== PersonVO ===
	* '''type''' - Tipo de pessoa, Física ou Jurídica		* '''type''' - Tipo de pessoa, Física ou Jurídica
	* '''displayname''' - Nome de exibição. Um nome amigável que o usuário possa definir como quiser para identificar a pessoa. Ficando livre para criar seu próprio padrão como "Rodrigo Leitão (Barinella)" ou "Rodrigo - Barinella" ou ainda "Técnico: Máquina de Lavar (Mário)". Na UI, o BIS poderia oferecer para gerar esse campo automaticamente sugerindo alguns padrões de acordo similar ao que o outlook express funciona.		* '''displayname''' - Nome de exibição. Um nome amigável que o usuário possa definir como quiser para identificar a pessoa. Ficando livre para criar seu próprio padrão como "Rodrigo Leitão (Barinella)" ou "Rodrigo - Barinella" ou ainda "Técnico: Máquina de Lavar (Mário)". Na UI, o BIS poderia oferecer para gerar esse campo automaticamente sugerindo alguns padrões de acordo similar ao que o outlook express funciona.
Linha 53:		Linha 54:


	==== PersonFieldVO ====		=== PersonFieldVO ===
	O PersonFieldVO mistura diversos tipos de campos, que só serão diferenciados pelo campo '''type'''. Optamos por manter todas as informações em um único objeto ao invés de um monte separado para simplificar o desenvolvimento, a persistência, e mesmo a performance de manipulação no banco de dados já que tudo fica em uma única tabela.		O PersonFieldVO mistura diversos tipos de campos, que só serão diferenciados pelo campo '''type'''. Optamos por manter todas as informações em um único objeto ao invés de um monte separado para simplificar o desenvolvimento, a persistência, e mesmo a performance de manipulação no banco de dados já que tudo fica em uma única tabela.
	* '''indexorder''' - Salva a ordem dos registros. A ordem é importante para definição de dados '''primários''' como telefones, e-mails, etc.		* '''indexorder''' - Salva a ordem dos registros. A ordem é importante para definição de dados '''primários''' como telefones, e-mails, etc.
Linha 66:		Linha 67:
	* '''valuedate''' - Campo utilizado para salvar os campos do tipo data, hora e data-hora.		* '''valuedate''' - Campo utilizado para salvar os campos do tipo data, hora e data-hora.

	==== PersonAddressVO ====		=== PersonAddressVO ===
	Este objeto mantém o cadastro de cada endereço definido. Ele utiliza o serviço de [[Location]] do BISCore, e consequentemente tem referências para seus objetos.		Este objeto mantém o cadastro de cada endereço definido. Ele utiliza o serviço de [[Location]] do BISCore, e consequentemente tem referências para seus objetos.
	* '''indexorder''' - Define a ordem dos endereços. A ordem é importante para definir endereços primários/principais, assim como para sempre exibir para o usuário na mesma ordem que ele salvou.		* '''indexorder''' - Define a ordem dos endereços. A ordem é importante para definir endereços primários/principais, assim como para sempre exibir para o usuário na mesma ordem que ele salvou.
Linha 78:		Linha 79:
	* '''LocationAddressVO''' - Referência ao definir a rua. Não é obrigatório, mas é recomendado para manter o endereço vinculado ao cadastro de ruas do serviço de Locaiton.		* '''LocationAddressVO''' - Referência ao definir a rua. Não é obrigatório, mas é recomendado para manter o endereço vinculado ao cadastro de ruas do serviço de Locaiton.

	=== PreProcess & Validação ===		== PreProcess & Validação ==

	==== Validações ====		=== Validações ===
	* Campos Obrigatórios		* Campos Obrigatórios
	** Verificar a obrigatoriedade já definida no modelo o Banco		** Verificar a obrigatoriedade já definida no modelo o Banco
Linha 99:		Linha 100:
	* '''PersonAddressVO''' - Nenhuma validação		* '''PersonAddressVO''' - Nenhuma validação

	==== PreProcessamentos ====		=== PreProcessamentos ===
	** '''PersonFieldVO'''		** '''PersonFieldVO'''
	*** '''indexorder''' - Criar o indexorder começando em 0 de acordo com a posição do item na lista.		*** '''indexorder''' - Criar o indexorder começando em 0 de acordo com a posição do item na lista.
Linha 108:		Linha 109:
	*** '''cep''' - Se preenchido, procurar pelo LocationAddress e se encontrado copiar suas informações e associar ao PersonAddressVO incluindo a associação à LocationCityVO, se não encontrado garantir que nenhum LocationAddressVO ficará associado ao PersonAddressVO.		*** '''cep''' - Se preenchido, procurar pelo LocationAddress e se encontrado copiar suas informações e associar ao PersonAddressVO incluindo a associação à LocationCityVO, se não encontrado garantir que nenhum LocationAddressVO ficará associado ao PersonAddressVO.

	=== UI Vaadin ===		== UI Vaadin ==

	O Person não tem uma tela específica para manipular as pessoas. O que ele oferece é um componente ([[PersonComponent]]) que pode ser acoplado nas telas que precisam incluir o cadastro de uma pessoa física ou jurídica.		O Person não tem uma tela específica para manipular as pessoas. O que ele oferece é um componente ([[PersonComponent]]) que pode ser acoplado nas telas que precisam incluir o cadastro de uma pessoa física ou jurídica.

Rodrigogml em 14h33min de 13 de março de 2025

2025-03-13T14:33:28Z

← Edição anterior		Edição das 14h33min de 13 de março de 2025
Linha 1:		Linha 1:
			Este módulo começou no BIS2 e também no BIS10, esta página armazena a informação do módulo de ambas as versões.

			= BIS10 =




			== BIS2 ==


	O serviço de pessoas oferecido pelo BISCore tem a finalidade de centralizar o cadastro de pessoas físicas e jurídicas por todo o sistema. A entidade Person conterá todos os dados relacionados à pessoa, e deve usada de forma compartilhada pelos plugins e módulos.		O serviço de pessoas oferecido pelo BISCore tem a finalidade de centralizar o cadastro de pessoas físicas e jurídicas por todo o sistema. A entidade Person conterá todos os dados relacionados à pessoa, e deve usada de forma compartilhada pelos plugins e módulos.

	Em sua primeira versão, Person começa oferecendo um conjunto de campos para cada tipo de pessoa. Em versões futuras novos campos deverão ser oferecidos para centralizar o máximo de informações possíveis.		Em sua primeira versão, Person começa oferecendo um conjunto de campos para cada tipo de pessoa. Em versões futuras novos campos deverão ser oferecidos para centralizar o máximo de informações possíveis.

	== Estrutura ==		=== Estrutura ===

	O serviço oferece o objecto PersonVO para representar cada pessoa. Dentro de PersonVO há dois outros objetos:		O serviço oferece o objecto PersonVO para representar cada pessoa. Dentro de PersonVO há dois outros objetos:
Linha 15:		Linha 25:


	== Funcionamento e Usabilidade ==		=== Funcionamento e Usabilidade ===

	O sistema não permitirá duas pessoas cadastradas com o Mesmo CPF/CNPJ, no entanto, permitirá que se cadastre uma pessoa sem o CPF ou CNPJ. Por isso, é recomendável que antes de associar um PersonVO novo em um determinado objeto, é aconselhável verificar se não existe ainda um Person com aquele CPF/CNPJ. Neste caso é aconselhável associar o objeto já existente. Como implementar essa usabilidade na UI do usuário deve ser definida na documentação de cada tipo de UI.		O sistema não permitirá duas pessoas cadastradas com o Mesmo CPF/CNPJ, no entanto, permitirá que se cadastre uma pessoa sem o CPF ou CNPJ. Por isso, é recomendável que antes de associar um PersonVO novo em um determinado objeto, é aconselhável verificar se não existe ainda um Person com aquele CPF/CNPJ. Neste caso é aconselhável associar o objeto já existente. Como implementar essa usabilidade na UI do usuário deve ser definida na documentação de cada tipo de UI.

	=== Funcionamento do Endereço ===		==== Funcionamento do Endereço ====

	O Person utiliza o serviço de Location para cadastrar um endereço. Caso o CEP seja preenchido, o sistema verificará se o CEP é conhecido pelo Location, e em caso positivo, copiará as informações do Location por cima de qualquer informação definida no PersonAddressVO. Mantendo inalterado apenas campos adicionais como Número e Complemento. Caso o CEP não seja conhecido, ele não será cadastrado no serviço de Location, mas será permitido que o usuário utilize o endereço digitado manualmente (Sem associação com o LocationAddress).		O Person utiliza o serviço de Location para cadastrar um endereço. Caso o CEP seja preenchido, o sistema verificará se o CEP é conhecido pelo Location, e em caso positivo, copiará as informações do Location por cima de qualquer informação definida no PersonAddressVO. Mantendo inalterado apenas campos adicionais como Número e Complemento. Caso o CEP não seja conhecido, ele não será cadastrado no serviço de Location, mas será permitido que o usuário utilize o endereço digitado manualmente (Sem associação com o LocationAddress).

	== Campos ==		=== Campos ===

	Aqui estão relacionados os campos atuais dos objetos, sua finalidades e requisitos:		Aqui estão relacionados os campos atuais dos objetos, sua finalidades e requisitos:

	=== PersonVO ===		==== PersonVO ====
	* '''type''' - Tipo de pessoa, Física ou Jurídica		* '''type''' - Tipo de pessoa, Física ou Jurídica
	* '''displayname''' - Nome de exibição. Um nome amigável que o usuário possa definir como quiser para identificar a pessoa. Ficando livre para criar seu próprio padrão como "Rodrigo Leitão (Barinella)" ou "Rodrigo - Barinella" ou ainda "Técnico: Máquina de Lavar (Mário)". Na UI, o BIS poderia oferecer para gerar esse campo automaticamente sugerindo alguns padrões de acordo similar ao que o outlook express funciona.		* '''displayname''' - Nome de exibição. Um nome amigável que o usuário possa definir como quiser para identificar a pessoa. Ficando livre para criar seu próprio padrão como "Rodrigo Leitão (Barinella)" ou "Rodrigo - Barinella" ou ainda "Técnico: Máquina de Lavar (Mário)". Na UI, o BIS poderia oferecer para gerar esse campo automaticamente sugerindo alguns padrões de acordo similar ao que o outlook express funciona.
Linha 43:		Linha 53:


	=== PersonFieldVO ===		==== PersonFieldVO ====
	O PersonFieldVO mistura diversos tipos de campos, que só serão diferenciados pelo campo '''type'''. Optamos por manter todas as informações em um único objeto ao invés de um monte separado para simplificar o desenvolvimento, a persistência, e mesmo a performance de manipulação no banco de dados já que tudo fica em uma única tabela.		O PersonFieldVO mistura diversos tipos de campos, que só serão diferenciados pelo campo '''type'''. Optamos por manter todas as informações em um único objeto ao invés de um monte separado para simplificar o desenvolvimento, a persistência, e mesmo a performance de manipulação no banco de dados já que tudo fica em uma única tabela.
	* '''indexorder''' - Salva a ordem dos registros. A ordem é importante para definição de dados '''primários''' como telefones, e-mails, etc.		* '''indexorder''' - Salva a ordem dos registros. A ordem é importante para definição de dados '''primários''' como telefones, e-mails, etc.
Linha 56:		Linha 66:
	* '''valuedate''' - Campo utilizado para salvar os campos do tipo data, hora e data-hora.		* '''valuedate''' - Campo utilizado para salvar os campos do tipo data, hora e data-hora.

	=== PersonAddressVO ===		==== PersonAddressVO ====
	Este objeto mantém o cadastro de cada endereço definido. Ele utiliza o serviço de [[Location]] do BISCore, e consequentemente tem referências para seus objetos.		Este objeto mantém o cadastro de cada endereço definido. Ele utiliza o serviço de [[Location]] do BISCore, e consequentemente tem referências para seus objetos.
	* '''indexorder''' - Define a ordem dos endereços. A ordem é importante para definir endereços primários/principais, assim como para sempre exibir para o usuário na mesma ordem que ele salvou.		* '''indexorder''' - Define a ordem dos endereços. A ordem é importante para definir endereços primários/principais, assim como para sempre exibir para o usuário na mesma ordem que ele salvou.
Linha 68:		Linha 78:
	* '''LocationAddressVO''' - Referência ao definir a rua. Não é obrigatório, mas é recomendado para manter o endereço vinculado ao cadastro de ruas do serviço de Locaiton.		* '''LocationAddressVO''' - Referência ao definir a rua. Não é obrigatório, mas é recomendado para manter o endereço vinculado ao cadastro de ruas do serviço de Locaiton.

	== PreProcess & Validação ==		=== PreProcess & Validação ===

	=== Validações ===		==== Validações ====
	* Campos Obrigatórios		* Campos Obrigatórios
	** Verificar a obrigatoriedade já definida no modelo o Banco		** Verificar a obrigatoriedade já definida no modelo o Banco
Linha 89:		Linha 99:
	* '''PersonAddressVO''' - Nenhuma validação		* '''PersonAddressVO''' - Nenhuma validação

	=== PreProcessamentos ===		==== PreProcessamentos ====
	** '''PersonFieldVO'''		** '''PersonFieldVO'''
	*** '''indexorder''' - Criar o indexorder começando em 0 de acordo com a posição do item na lista.		*** '''indexorder''' - Criar o indexorder começando em 0 de acordo com a posição do item na lista.
Linha 98:		Linha 108:
	*** '''cep''' - Se preenchido, procurar pelo LocationAddress e se encontrado copiar suas informações e associar ao PersonAddressVO incluindo a associação à LocationCityVO, se não encontrado garantir que nenhum LocationAddressVO ficará associado ao PersonAddressVO.		*** '''cep''' - Se preenchido, procurar pelo LocationAddress e se encontrado copiar suas informações e associar ao PersonAddressVO incluindo a associação à LocationCityVO, se não encontrado garantir que nenhum LocationAddressVO ficará associado ao PersonAddressVO.

	== UI Vaadin ==		=== UI Vaadin ===

	O Person não tem uma tela específica para manipular as pessoas. O que ele oferece é um componente ([[PersonComponent]]) que pode ser acoplado nas telas que precisam incluir o cadastro de uma pessoa física ou jurídica.		O Person não tem uma tela específica para manipular as pessoas. O que ele oferece é um componente ([[PersonComponent]]) que pode ser acoplado nas telas que precisam incluir o cadastro de uma pessoa física ou jurídica.

Rodrigogml: /* UI */

2015-05-30T21:35:59Z

← Edição anterior		Edição das 21h35min de 30 de maio de 2015
Linha 100:		Linha 100:
	== UI Vaadin ==		== UI Vaadin ==

	~~=== PersonComponent ===~~		O Person não tem uma tela específica para manipular as pessoas. O que ele oferece é um componente ([[PersonComponent]]) que pode ser acoplado nas telas que precisam incluir o cadastro de uma pessoa física ou jurídica.

	O PersonComponent é um componente usado na UI do BIS que permite que telas dos módulos e plugins manipulem o objeto PersonVO sem a necessidade de incluir campo à campo em sua tela. Este componente recebe (ou não~~) um PersonVO, cria os campos e já o associa completamente. Desta forma, invés do desenvolvedor da~~ tela ~~ter que criar e obter o valor de cada campo, basta incluir este componente e obter o valor através do método:~~

	~~<pre>getPersonVO();</pre>~~

	~~==== Requisitos & Regras de Funcionamento ====~~

	A principal ideia do serviço Person do BISCore é garantir um "cadastro único" das pessoas (Físicas e Jurídicas) em todo o sistema. Permitindo que as pessoas cadastradas em um módulo estejam disponíveis em outros módulo. Já a ideia do PersonComponent é simplificar a implementação dessa ideia nas telas dos módulos que utilizam o Person para manipular ~~o cadastro dessas~~ pessoas. ~~Assim, temos as seguintes regras:~~

	# O ~~componente deve identificar automaticamente o tipo de pessoa (física ou jurídica) de acordo com o valor digitado em "CPF/CNPJ:".~~
	~~# Para os casos em~~ que ~~o usuário não informe (ou não saiba) o CPF/CNPJ, o componente deve ter~~ um ~~campo (combobox) com as opções: "Pessoa Física Sem CPF" e "Pessoa Jurídica sem CNPJ" que permitam o componente identificar o tipo de pessoa sendo cadastrada sem a necessidade do documento.~~
	~~# O~~ componente ~~deve estender algum tipo de layout (Grid, VerticalLayout, etc.) sem incluir nenhum "Panel"~~ (como o BISPanel). Deixando a prerrogativa de ser inserido em um Panel ou não para a tela que o for utilizar. Algumas telas, por exemplo, podem preferir inseri-lo diretamente em alguma "Aba" do PanelTab, BISPopupPanel, etc..
	~~# Devido a resolução definida no~~ [[~~Padrão Visual]] o componente deve caber em uma dimensão mínima de 1000px (Largura) x 500px (Altura). E deve ser preparado para "esticar" para resoluções maiores.~~


	~~===== Regras de Habilitação dos Campos =====~~
	~~# O campo "CPF/CNPJ:" é o único campo que ficará sempre habilitado.~~
	~~# O campo "Tipo de Cadastro:" só fica habilitando enquanto o campo "CPF/CNPJ:" estiver em branco.~~
	~~# Quando o "CPF/CNPJ:" for preenchido, o campo "Tipo de Cadastro:" deverá ter a opção "Cadastro Completo" selecionada e ser desabilitado.~~
	~~# Os demais serão desabilitados sempre que o campo "CPF/CNPJ:" estiver vazio E o campo "Tipo de Cadastro:" não estiver definido com uma das opções de "Cadastro Incompleto".~~

	~~Quando uma das duas condições for falsa, os campos devem estar habilitados para edição, ou seguir suas próprias regras de habilitado/desabilitado.}}~~

	~~===== Construtor =====~~
	~~Lógica de construção:~~
	~~# O construtor do~~ PersonComponent ~~deve receber um PersonVO como atributo, sendo que se o objeto recebido for:~~
	~~## '''nulo:''' o componente deve criar um novo PersonVO e associar todos os campos a este novo PersonVO.~~
	~~### Assim que criado o componente deve ter todos os seus campos desabilitados. Permitir apenas o campo "CPF/CNPJ:" e o "Tipo de Cadastro:" habilitados para preenchimento.~~
	~~## '''Não for Nulo''', utiliza o objeto recebido para associar aos campos.~~


	{{nota\|Habilitando/Desabilitando em Massa\|O melhor para habilitar e desabilitar todos os componentes é utilizar algum container e desabilita-lo ao invés de ir campo a campo. Assim, evita inclusive a interferência de acabar habilitando algum campo que tem sua própria lógica de habilitação. Habilitando algum componente que deveria continuar desabilitado, como o caso do campo "Nome da Rua" que deve continuar desabilitado de acordo com o preenchimento do campo "CEP:".

	~~No caso do esboço, a maneira mais fácil será desabilitar o próprio TabPanel, se possível.}}~~


	~~===== Campo: CPF/CNPJ =====~~

	~~Uma vez que o componente foi criado de acordo com a regra do construtor, o usuário poderá alterar o valor do campo "CPF/CNPJ:". Neste caso devemos seguir as seguintes regras:~~
	* '''Caso o novo valor seja um CPF/CNPJ válido...'''
	** '''...e o novo valor não esteja no banco:''' Simplesmente deixamos que o CPF/CNPJ seja alterado no PersonVO que já estamos editando. Fazendo com que o objeto seja inserido com o novo valor.
	** '''...e o novo valor esteja no banco:''' Exibimos um dialog ([[BISConfirmCancelDialog]]) ~~com a seguinte indagação:~~
	**: No caso de CPF: "O CPF já está em uso por outra pessoa. Gostaria de utilizar os dados existentes?"
	**: No caso de CNPJ: "O CNPJ já está em uso por outra empresa. Gostaria de utilizar os dados existentes?"
	**: Caso o dialog seja '''confirmado''' o objeto atual deve ser substituído pelo novo. Associar o novo objeto aos campos de tela os valores serão atualizados para os dados que ~~vieram do banco de dados. Em caso de '''cancelamento''' o valor do campo "CPF/CNPJ:" deve~~ ser ~~limpo. Impedindo que o usuário tente inserir ou alterar o objeto atual para o CPF/CNPJ que já está em branco.~~
	* '''Caso o novo valor esteja em branco:''' permite que o PersonVO receba o novo valor em branco.


	{{nota\|Valores Inválidos\|Caso o valor seja definido como um valor inválido, não é considerado como se o valor tivesse sido alterado. O vaadin nem sequer passar o valor para o VO. Por isso não nos preocupamos se o usuário fizer a troca para um valor inválido.}}


	~~===== Campo: Tipo de Cadastro =====~~

	Como o componente deve permitir que o usuário cadastre uma nova pessoa sem o CPF ou CNPJ. Para isso deve incluir do lado do campo "CPF/CNPJ:" um combobox com o título "Tipo de Cadastro:". Este combo terá as seguintes opções:
	* '''Cadastro Completo''' - Quando esta opção for escolhida o combo, os outros campos só serão habilitados de acordo com o preenchimento do campo "CPF/CNPJ:"
	* '''Pessoa Física sem CPF''' - Quando esta opção for escolhida o campo CPF/CNPJ deve ser limpo e desabilitado. Os demais campos devem ser habilitados para edição. A aba de informações PJ deve ser ocultada.
	* '''Pessoa Jurídica sem CNPJ''' - Quando esta opção for escolhida o campo CPF/CNPJ deve ser limpo e desabilitado. Os demais campos devem ser habilitados para edição. A aba de informações PF deve ser ocultada.

	~~==== Esboço da UI ====~~

	~~Abaixo estão alguns esboços sobre a composição do componente e algumas observações:~~

	Para organizar todos os campos do objeto, os campos serão agrupados em abas de um TabPanel. Permitindo inclusive que os campos que o PersonVO venha a ganhar no futuro possam ser incluídos no componente sem desfigurar sua aparência atual.

	~~[[Image:PersonComponent_IdentificacaoPF.png\|center\|link=\|framed\|Identificação Pessoa Física]]~~
	~~[[Image:PersonComponent_IdentificacaoPJ.png\|center\|link=\|framed\|Identificação Pessoa Jurídica]]~~

	Na aba "Identificação" mantemos os campos referente a identificação de cada pessoa (Física ou Jurídica) Por isso uma aba diferente para cada pessoa. Dependendo do valor informado em "CPF/CNPJ" a aba correspondente deve aparecer. Caso não seja informado, a aba que aparecerá será de acordo com as opções do tipo de pessoa no combobox "Tipo de Cadastro". Lembrando que ~~todo o tabpanel só ficará habilitado quando uma das informações já tiver sido definida.~~

	~~[[Image:PersonComponent_Contato.png\|center\|link=\|framed\|Contato]]~~

	~~Na aba contato teremos 3 listas. Para inclusão de números de telefones, e-mails e websites. A tela deve~~ incluir ~~uma nova coleção de campos para "telefone" a cada vez que~~ o ~~usuário clicar no campo "Adicionar Novo Telefone". O mesmo para o e-mail e websites. Similar ao funcionamento desses campos em~~ cadastro de ~~contatos atualmente no Android e iOS.~~

	~~O campo "Label", que servirá para o usuário criar alguma identificação para o dado, deverá ter um PoupUp que exiba~~ uma lista dos labels já utilizados, preferencialmente na ordem do mais usado para o menos usado. Ao clicar em um item na lista o mesmo label é definido na caixa de label. Não utilizamos um combo pois o usuário poderá inserir um valor que ainda não tenha sido utilizado.

	~~[[Image:PersonComponent_Endereco.png\|center\|link=\|framed\|Endereços]]~~

	A aba de endereços tem a finalidade de permitir que o usuário gerencie endereços dos contatos. Podendo ser salvo mais de um endereço, como por exemplo, o endereço da fábrica, da loja, do estoque, etc. O funcionamento da tela segue o mesmo conceito da aba de contatos, a cada clique no botão "Adcionar ..." um novo bloco de endereço é adicionado.

	~~[[Image:PersonComponent_DadosBancarios.png\|center\|link=\|framed\|Dados Bancários]]~~

	~~A aba de Dados Bancários funciona como a aba de contatos ao gerenciar a lista de dados bancários. A cada clique no botão "Adicionar..." um novo bloco é criado para a entrada de novos dados.~~

	~~[[Image:PersonComponent_Notas.png\|center\|link=\|framed\|Notas]]~~

	~~Esta aba simplesmente exibe um campo de TextArea livre para que o usuário possa escrever o que preferir sobre a~~ pessoa~~. Permitindo que informações sem campo próprio possam ser "salvas" até que um lugar apropriado seja criado~~.

Rodrigogml: /* UI */

2015-05-30T21:29:32Z

@@ Linha 98: / Linha 98: @@
 *** '''cep''' - Se preenchido, procurar pelo LocationAddress e se encontrado copiar suas informações e associar ao PersonAddressVO incluindo a associação à LocationCityVO, se não encontrado garantir que nenhum LocationAddressVO ficará associado ao PersonAddressVO.
-== UI ==
+== UI Vaadin ==
-O Person deve oferecer um componente para tratar o PersonVO e suas subclasses para as UIs suportadas pelo BISERP. Verifique a documentação de de cada UI para saber como utilizar este componente.
+=== PersonComponent ===

Rodrigogml: /* Validações */

2015-05-25T23:11:10Z

Validações

Rodrigogml: /* PreProcess & Validação */

2015-04-13T22:59:09Z

PreProcess & Validação

← Edição anterior		Edição das 22h59min de 13 de abril de 2015
Linha 70:		Linha 70:
	== PreProcess & Validação ==		== PreProcess & Validação ==

	* Validações		=== Validações ===
	** Campos Obrigatórios		** Campos Obrigatórios
	*** Verificar a obrigatoriedade já definida no modelo o Banco		*** Verificar a obrigatoriedade já definida no modelo o Banco
Linha 88:		Linha 88:
	**** '''PHONE''' - Valida se o telefone está preenchido corretamente. Obrigar a presença do DDD, validando assim o tamanho do número para fixo e celulares com o 9°dígito.		**** '''PHONE''' - Valida se o telefone está preenchido corretamente. Obrigar a presença do DDD, validando assim o tamanho do número para fixo e celulares com o 9°dígito.
	** '''PersonAddressVO''' - Nenhuma validação		** '''PersonAddressVO''' - Nenhuma validação
	* PreProcessamentos
			=== PreProcessamentos ===
	** '''PersonFieldVO'''		** '''PersonFieldVO'''
	*** '''indexorder''' - Criar o indexorder começando em 0 de acordo com a posição do item na lista.		*** '''indexorder''' - Criar o indexorder começando em 0 de acordo com a posição do item na lista.
Linha 96:		Linha 97:
	*** '''indexorder''' - Criar o indexorder começando em 0 de acordo com a posição do item na lista.		*** '''indexorder''' - Criar o indexorder começando em 0 de acordo com a posição do item na lista.
	*** '''cep''' - Se preenchido, procurar pelo LocationAddress e se encontrado copiar suas informações e associar ao PersonAddressVO incluindo a associação à LocationCityVO, se não encontrado garantir que nenhum LocationAddressVO ficará associado ao PersonAddressVO.		*** '''cep''' - Se preenchido, procurar pelo LocationAddress e se encontrado copiar suas informações e associar ao PersonAddressVO incluindo a associação à LocationCityVO, se não encontrado garantir que nenhum LocationAddressVO ficará associado ao PersonAddressVO.


	== UI ==		== UI ==

	O Person deve oferecer um componente para tratar o PersonVO e suas subclasses para as UIs suportadas pelo BISERP. Verifique a documentação de de cada UI para saber como utilizar este componente.		O Person deve oferecer um componente para tratar o PersonVO e suas subclasses para as UIs suportadas pelo BISERP. Verifique a documentação de de cada UI para saber como utilizar este componente.

Rodrigogml em 21h52min de 13 de abril de 2015

2015-04-13T21:52:55Z

@@ Linha 3: / Linha 3: @@
 Em sua primeira versão, Person começa oferecendo um conjunto de campos para cada tipo de pessoa. Em versões futuras novos campos deverão ser oferecidos para centralizar o máximo de informações possíveis.
-== Funcionamento ==
+== Estrutura ==
 O serviço oferece o objecto PersonVO para representar cada pessoa. Dentro de PersonVO há dois outros objetos:
@@ Linha 14: / Linha 14: @@
 {{stop|Persistência Automática|Como o BISCore utiliza as definições da JPA para persistir seus objetos, a maneira de evitar que o objeto seja persistido ou alterado automaticamente ao persistir um objeto que utilize o PersonVO, é garantir que no mapeamento seja definida a expressão '''"cascade <nowiki>=</nowiki> CascadeType.REFRESH"''' nos mapeamentos OneToOne, ManyToOne ou OneToMany.}}
-O sistema não permitirá duas pessoas cadastradas com o Mesmo CPF/CNPJ, no entanto, permitirá que se cadastre uma pessoa sem o CPF ou CNPJ. Ao associar pessoas à outros objetos sempre verificar se já existe uma pessoa pelo CPF/CNPJ
 == Campos ==
@@ Linha 60: / Linha 67: @@
 * '''LocationCityVO''' - Referência ao objeto que representa a cidade. Obrigatório. ao definir a cidade.
 * '''LocationAddressVO''' - Referência ao definir a rua. Não é obrigatório, mas é recomendado para manter o endereço vinculado ao cadastro de ruas do serviço de Locaiton.
 == UI ==
 O Person deve oferecer um componente para tratar o PersonVO e suas subclasses para as UIs suportadas pelo BISERP. Verifique a documentação de de cada UI para saber como utilizar este componente.

← Edição anterior		Edição das 23h11min de 25 de maio de 2015
Linha 71:		Linha 71:

	=== Validações ===		=== Validações ===
	** Campos Obrigatórios		* Campos Obrigatórios
	*** Verificar a obrigatoriedade já definida no modelo o Banco		** Verificar a obrigatoriedade já definida no modelo o Banco
	** Verificar Unicidade dos Campos no Banco de Dados		* Verificar Unicidade dos Campos no Banco de Dados
	*** PersonVO.displayline		** PersonVO.displayline
	*** PersonVO.cpfcnpj (Se não nulo)		** PersonVO.cpfcnpj (Se não nulo)
	** '''PersonVO'''		* '''PersonVO'''
	*** '''cpfcnpj''' - validar se numeração é válida de acordo com o type definido.		** '''cpfcnpj''' - validar se numeração é válida de acordo com o type definido.
	*** '''ie''' - validar se numeração é valida		** '''ie''' - validar se numeração é valida
	*** '''birthdate''' - validar se data é passada.		** '''birthdate''' - validar se data é passada.
	** '''PersonFieldVO'''		* '''PersonFieldVO'''
	*** '''type''' - Verificar se esta preenchido, e para cada tipo aceito verificar se os campos "value" que não são utilizados estão definidos como null e fazer as validações específicas abaixo:		** '''type''' - Verificar se esta preenchido, e para cada tipo aceito verificar se os campos "value" que não são utilizados estão definidos como null e fazer as validações específicas abaixo:
	**** '''EMAIL''' - Validar se o e-mail está em um formato válido.		*** '''EMAIL''' - Validar se o e-mail está em um formato válido.
	**** '''WEBSITE''' - validar se o site tem um endereço válido.		*** '''WEBSITE''' - validar se o site tem um endereço válido.
	**** '''CUSTOMDATE''' - Validar se a data está adequada e se o horário está zerado.		*** '''CUSTOMDATE''' - Validar se a data está adequada e se o horário está zerado.
	**** '''CUSTOMTEXT''' - Nada específico para validar.		*** '''CUSTOMTEXT''' - Nada específico para validar.
	**** '''PHONE''' - Valida se o telefone está preenchido corretamente. Obrigar a presença do DDD, validando assim o tamanho do número para fixo e celulares com o 9°dígito.		*** '''PHONE''' - Valida se o telefone está preenchido corretamente. Obrigar a presença do DDD, validando assim o tamanho do número para fixo e celulares com o 9°dígito.
	** '''PersonAddressVO''' - Nenhuma validação		* '''PersonAddressVO''' - Nenhuma validação

	=== PreProcessamentos ===		=== PreProcessamentos ===