Edição das 15h49min de 18 de dezembro de 2013

Objetivo

• Manter cadastro de CNAE.

Atores

• Usuário

Pré-requisitos

• Considerar documento Padrões de desenvolvimento.
• No projeto da rotina, em confsrc > META-INF > messages > view.properties definir o nome como CNAE. Este nome será utilizado para criar a página no Wiki.
• Utilizar grid com pesquisa por contexto (lucene) paginado.
• Ter cadastrados no banco de dados do sistema todos os códigos e descrições de CNAE conforme esta tabela. Por padrão todos os CNAE´s deverão ser cadastrados como inativos, fazendo com que o usuário ative somente aqueles que irá de fato utilizar.

Resultado esperado

• Cadastrar no sistema códigos nacionais de atividades econômicas (CNAE).

Diagrama de classes

Fluxo de eventos

Fluxos principais

Fluxo 1: Usuário acessa a rotina Menu -> Cadastros -> Faturamento -> Item -> Imposto -> CNAE.

• Sistema exibe a tela de pesquisa da rotina em questão conforme RN01.

Fluxo 2: Usuário aciona o botão <Adicionar CNAE>.

• Sistema exibe a tela de manutenção da rotina conforme RN02.

Fluxo 3: Usuário informa os dados do CNAE e aciona o botão <Salvar>.

• Sistema cadastra novo CNAE na base de dados.

Fluxos alternativos

Fluxo 1: Na tela de pesquisa, usuário digita no campo de pesquisa (lucene) pelo menos 3 dígitos do código ou da descrição do CNAE desejado.

• Sistema repopula o grid listando somente resultados pertinentes ao filtro informado.

Fluxo 2: Na tela de pesquisa, usuário aciona o botão <Consultar> na última coluna do grid para um determinado registro.

• Sistema exibe a tela de manutenção da rotina com os dados do registro cujo botão <Consultar> foi acionado em modo de consulta.

Fluxo 3: Na tela de pesquisa, usuário aciona o botão <Alterar> na última coluna do grid para um determinado registro.

• Sistema exibe a tela de manutenção da rotina com os dados do registro cujo botão <Consultar> foi acionado em modo de alteração.

Fluxo 4: Na tela de pesquisa, usuário aciona o botão <Excluir> na última coluna de um determinado registro.

• Se o registro é passível de ser excluído, sistema exibe mensagem de confirmação ao usuário perguntando se ele deseja realmente excluí-lo. Caso usuário clique em sim, o registro é permanentemente excluído. Caso contrário a exclusão é abortada.

Fluxo 5: Na tela de manutenção, em modo de consulta, usuário aciona o botão <Alterar>.

• Sistema habilita os campos da tela permitindo ao usuário alterar os dados do registro em questão.

Fluxo 6: Na tela de manutenção, em modo de consulta, usuário aciona o botão <Excluir>.

• Se o registro é passível de ser excluído, sistema exibe mensagem de confirmação ao usuário perguntando se ele deseja realmente excluí-lo. Caso usuário clique em sim, o registro é permanentemente excluído. Caso contrário a exclusão é abortada.

Fluxos de exceção

Fluxo 1: Na tela de pesquisa ou de manutenção usuário tenta excluir um CNAE que já foi relacionado a uma lista de serviço.

• Sistema aborta a exclusão e emite ao usuário a seguinte mensagem de alerta: Este registro está relacionado à lista de serviços X, e portanto sua exclusão não é permitida.. Onde X corresponde à descrição da lista de serviço.

Fluxo 2: Em modo de inclusão, usuário informa no campo Código CNAE um código já cadastrado.

• Sistema emite ao usuário uma mensagem de alerta informando que o código em questão já está cadastrado e mantem o foco no campo em questão.

Fluxo 3: Em modo de inclusão, na seção de detalhe, usuário aciona o botão <Adicionar> sem informar nenhum ou alguns dados.

• Sistema aborta a inclusão no grid e emite ao usuário uma mensagem de alerta informando quais campos são obrigatórios de acordo com o quadro de dados.

Fluxo 4: Em modo de inclusão, na seção de detalhe, usuário informa uma cidade e uma atividade econômica local já adicionados no grid e aciona o botão <Adicionar>.

• Sistema aborta a inclusão do registro no grid e emite ao usuário uma mensagem de alerta com a não conformidade.

Regras de negócio

RN01 - Descrição dos campos e funcionalidades da tela de pesquisa

1. Adicionar CNAE: Botão que quando acionado exibe a tela de manutenção da rotina em questão.
2. Pesquisa (lucene): Campo localizado no canto superior direito da tela, que permite ao usuário digitar qualquer informação referente ao CNAE (listada em colunas do grid) para filtrar um determinado registro.
3. GRID: Lista todos os CNAE´s cadastrados no sistema exibindo seus dados nas seguintes colunas:
   • CÓDIGO: Código nacional da atividade econômica (CNAE).
   • DESCRIÇÃO: Descrição do CNAE.
   • ALIQ. ISSQN: Alíquota do ISSQN.
   • ATIVO: Informa se um determinado registro está ativo para uso no sistema ou não.

     
    O sistema não fará uso de máscaras para os códigos de CNAE.

    Uma determinada cidade e atividade econômica (código+descrição) só podem existir no grid uma única vez. A cidade poderá ser
    adicionada no grid mais de uma vez desde que a atividade econômica não se repita. Da mesma forma a atividade econômica poderá
    repetir, mas com cidades diferentes.