quarta-feira, 1 de julho de 2020

Contas Pagar/Receber - Parte X - Parâmetros

Introdução
Nesse décimo post vou mostrar como utilizar a biblioteca de parâmetros do JARCH. Essa biblioteca permite o gerenciamento e utilização de parâmetros de um modo simples e prático. Para utilizar essa biblioteca é necessario estender algumas classes. Um de nossos clientes da nossa aplicação de Contas Pagar e Receber solicitou que fosse desabilitado as informações de Banco, Centro de Custo, Categoria e Pessoa, sua alegação é que essas informações pra ele são irrelevantes. Então vou demonstrar como atender a essa necessidade com parâmetros, uma vez que os demais clientes dessa aplicação vão utilizar essas informações.

Biblioteca Parâmetro 
O JARCH já possuí uma estrutura pronta para utilizar parâmetro, mas para isso precisa ser implementado algumas classes estendendo do JARCH. Então vou criar um pacote chamado parametro dentro do módulo client e vou implementar as seguintes classes:

ParametroEntity.java:

@Table(name = "tb_parametro")
@Entity(name = "parametro")
public class ParametroEntity extends BaseParameterEntity {
}
IParametroManager.java:

public interface IParametroManager extends IBaseParameterManager<ParametroEntity> {
}
ParametroFacade.java

public class ParametroFacade extends BaseParameterFacade<ParametroEntity, IParametroManager> {
}
ParametroAction.java:

@Named("parameterAction")
@ViewScoped
public class ParametroAction extends BaseParameterAction<ParametroFacade> {
}
ParametroFilterSelectAction.java:

@JArchViewScoped
public class ParametroFilterSelectAction extends BaseFilterSelectAction<ParametroEntity> {
}
ParametroJpaqlBuilder.java:

public final class ParametroJpaqlBuilder  {
    private ParametroJpaqlBuilder() {
    }

    public static ClientJpaql<ParametroEntity> newInstance() {
        return ClientJpaqlBuilder.newInstance(ParametroEntity.class);
    }
}
ParametroManager.java:

@Dependent
public class ParametroManager extends BaseParameterManager<ParametroEntity> implements IParametroManager {
}
ParametroSearch.java:

@Dependent
public class ParametroSearch extends Search<ParametroEntity> {
}
Pronto, agora a aplicação está preparada para utilizar os parâmetros.

Criando Parâmetros

Agora vou criar o primeiro parâmetro, que vai definir se vai ser utilizado o banco nos lançamentos:
ParametroUtilizaBanco.java:

@JArchParameter
public class ParametroUtilizaBanco extends Parameter<Boolean, ParametroFacade> {
    @Override
    public String system() {
        return BundleUtils.messageBundle("label.siglaSistema");
    }

    @Override
    public String category() {
        return BundleUtils.messageBundle("label.lancamento");
    }

    @Override
    public String description() {
        return BundleUtils.messageBundle("label.utilizaBanco");
    }

    @Override
    public String explanation() {
        return BundleUtils.messageBundle("message.utilizaBancoLancamento");
    }

    @Override
    public Boolean getValue() {
        return Boolean.valueOf(getValueString()) || getValueString().equals("S");
    }
    @Override
    public void setValue(Boolean value) {
        if (value == null) {
            setValueString(null);
        } else {
            setValueString(value ? "S" : "N");
        }    }

    @Override
    public FieldType getType() {
        return FieldType.BOOLEAN;
    }

    @Override
    public Boolean valueDefault() {
        return true;
    }


    @Override
    public int row() {
        return 1;
    }
}
bundle_pt_BR.properties:

label.utilizaBanco=Utiliza Banco
Agora ao acessar o menu Parâmetro:

Agora vamos definir os demais parâmetros de utilização do Centro Custo, Categoria e Pessoa.

ParametroUtilizaCentroCusto.java:

@JArchParameter
public class ParametroUtilizaCentroCusto extends Parameter<Boolean, ParametroFacade> {
    @Override
    public String system() {
        return BundleUtils.messageBundle("label.siglaSistema");
    }

    @Override
    public String category() {
        return BundleUtils.messageBundle("label.lancamento");
    }

    @Override
    public String description() {
        return BundleUtils.messageBundle("label.utilizaCentroCusto");
    }

    @Override
    public String explanation() {
        return BundleUtils.messageBundle("message.utilizaCentroCustoLancamento");
    }

    @Override
    public Boolean getValue() {
        return Boolean.valueOf(getValueString()) || getValueString().equals("S");
    }

    @Override
    public void setValue(Boolean value) {
        if (value == null) {
            setValueString(null);
        } else {
            setValueString(value ? "S" : "N");
        }    }

    @Override
    public FieldType getType() {
        return FieldType.BOOLEAN;
    }

    @Override
    public Boolean valueDefault() {
        return true;
    }

    @Override
    public int row() {
        return 2;
    }
}
ParametroUtilizaCategoria.java:

@JArchParameter
public class ParametroUtilizaCategoria extends Parameter<Boolean, ParametroFacade> {
    @Override
    public String system() {
        return BundleUtils.messageBundle("label.siglaSistema");
    }

    @Override
    public String category() {
        return BundleUtils.messageBundle("label.lancamento");
    }

    @Override
    public String description() {
        return BundleUtils.messageBundle("label.utilizaCategoria");
    }

    @Override
    public String explanation() {
        return BundleUtils.messageBundle("message.utilizaCategoriaLancamento");
    }

    @Override
    public Boolean getValue() {
        return Boolean.valueOf(getValueString()) || getValueString().equals("S");
    }

    @Override
    public void setValue(Boolean value) {
        if (value == null) {
            setValueString(null);
        } else {
            setValueString(value ? "S" : "N");
        }    }

    @Override
    public FieldType getType() {
        return FieldType.BOOLEAN;
    }

    @Override
    public Boolean valueDefault() {
        return true;
    }

    @Override
    public int row() {
        return 3;
    }
}
ParametroUtilizaPessoa.java:

@JArchParameter
public class ParametroUtilizaPessoa extends Parameter<Boolean, ParametroFacade> {
    @Override
    public String system() {
        return BundleUtils.messageBundle("label.siglaSistema");
    }

    @Override
    public String category() {
        return BundleUtils.messageBundle("label.lancamento");
    }

    @Override
    public String description() {
        return BundleUtils.messageBundle("label.utilizaPessoa");
    }

    @Override
    public String explanation() {
        return BundleUtils.messageBundle("message.utilizaPessoaLancamento");
    }

    @Override
    public Boolean getValue() {
        return Boolean.valueOf(getValueString()) || getValueString().equals("S");
    }

    @Override
    public void setValue(Boolean value) {
        if (value == null) {
            setValueString(null);
        } else {
            setValueString(value ? "S" : "N");
        }    }

    @Override
    public FieldType getType() {
        return FieldType.BOOLEAN;
    }

    @Override
    public Boolean valueDefault() {
        return true;
    }

    @Override
    public int row() {
        return 4;
    }
}
Ajustando o bundle_pt_BR.properties:
label.utilizaBanco=Utiliza Banco
label.utilizaCentroCusto=Utiliza Centro Custo
label.utilizaCategoria=Utiliza Categoria
label.utilizaPessoa=Utiliza Pessoa
Alterando os parametros para não utilizar as informações de Banco, Centro Custo, Categoria e Banco:

Vou agora ajustar a tela de lançamento para mostrar as informações de Banco, Centro Custo, Categoria e Pessoa de acordo com a configuração do parâmetro.Na action de dados vou injetar esses parametros e disponibilizar via gettter para configuração na página.
LancamentoDataAction.java: 

@JArchViewScoped
public class LancamentoDataAction extends CrudDataAction<LancamentoEntity, LancamentoFacade> {

   @Inject
   @JArchParameter
   private ParametroUtilizaBanco parametroUtilizaBanco;

   @Inject
   @JArchParameter
   private ParametroUtilizaCentroCusto parametroUtilizaCentroCusto;

   @Inject
   @JArchParameter
   private ParametroUtilizaCategoria parametroUtilizaCategoria;

   @Inject
   @JArchParameter
   private ParametroUtilizaPessoa parametroUtilizaPessoa;

   /** Código ocultado **\

   public boolean isUtilizaBanco() {
      return parametroUtilizaBanco.getValue();
   }

   public boolean isUtilizaCentroCusto() {
      return parametroUtilizaCentroCusto.getValue();
   }

   public boolean isUtilizaCategoria() {
      return parametroUtilizaCategoria.getValue();
   }

   public boolean isUtilizaPessoa() {
      return parametroUtilizaPessoa.getValue();
   }

   /** Código ocultado **\
}
lancamentoData.xhtml:
...
<a:panelGrid columns="1" rendered="#{lancamentoDataAction.utilizaBanco}">
    <h:panelGroup>
        <e:lookup id="idLancamentoBanco" labelUnique="#{e:bundle('label.banco')}"
                  header="#{e:bundle('label.banco')}" value="#{lancamentoDataAction.entity.banco}"
                  actionFilterSelect="#{bancoFilterSelectAction}"
                  disabled="#{lancamentoDataAction.blockedMaster}" required="true"
                  createExtensionInternal="true"/>
    </h:panelGroup>
</a:panelGrid>
<a:panelGrid columns="1" rendered="#{lancamentoDataAction.utilizaCentroCusto}">
    <h:panelGroup>
        <e:lookup id="idLancamentoCentroCusto" labelUnique="#{e:bundle('label.centroCusto')}"
                  header="#{e:bundle('label.centroCusto')}"
                  value="#{lancamentoDataAction.entity.centroCusto}"
                  actionFilterSelect="#{centroCustoFilterSelectAction}"
                  disabled="#{lancamentoDataAction.blockedMaster}" required="true"
                  createExtensionInternal="true"/>
    </h:panelGroup>
</a:panelGrid>
<a:panelGrid columns="1" rendered="#{lancamentoDataAction.utilizaCategoria}">
    <h:panelGroup>
        <e:lookup id="idLancamentoCategoria" labelUnique="#{e:bundle('label.categoria')}"
                  header="#{e:bundle('label.categoria')}"
                  value="#{lancamentoDataAction.entity.categoria}"
                  actionFilterSelect="#{categoriaFilterSelectAction}"
                  disabled="#{lancamentoDataAction.blockedMaster}" required="true"
                  createExtensionInternal="true"/>
    </h:panelGroup>
</a:panelGrid>
<a:panelGrid columns="1" rendered="#{lancamentoDataAction.utilizaPessoa}">
    <h:panelGroup>
        <e:lookup id="idLancamentoPessoa" labelUnique="#{e:bundle('label.pessoa')}"
                  header="#{e:bundle('label.pessoa')}" value="#{lancamentoDataAction.entity.pessoa}"
                  actionFilterSelect="#{pessoaFilterSelectAction}"
                  disabled="#{lancamentoDataAction.blockedMaster}" required="true"
                  createExtensionInternal="true" widthCode="120" typeCode="cpf-cnpj"/>
    </h:panelGroup>
</a:panelGrid>
...
Agora a tela de lançamento ficou assim:

Parâmetros Default
Nosso CRUD de lançamento obriga o preenchimento do Banco, Centro Custo, Categoria e Pessoa, mas como esses campos não serão mais mostrados na tela, então preciso preenche-los com um valor default. Eu poderia remover a obrigatoridade dos campos mas como essa aplicação é multitenant e os demais clientes vão utilizar essas informações então vou resolver isso através de parametros default. Para cada CRUD vou criar um parâmetro para configurar o valor default. 
ParamentroBancoDefault.java:

@JArchParameter
public class ParametroBancoDefault extends Parameter<BancoEntity, ParametroFacade> {
    @Override
    public String system() {
        return BundleUtils.messageBundle("label.siglaSistema");
    }

    @Override
    public String category() {
        return BundleUtils.messageBundle("label.lancamento");
    }

    @Override
    public String description() {
        return BundleUtils.messageBundle("label.bancoDefault");
    }

    @Override
    public String explanation() {
        return BundleUtils.messageBundle("message.bancoDefaultLancamento");
    }

    @Override
    public BancoEntity getValue() {
        if (getValueInteger() == null) {
            return null;
        }

        return BancoJpqlBuilder
            .newInstance()
            .where()
                .equalsTo(BancoEntity_.id, getValueInteger().longValue())
            .collect()
            .singleOptional()
            .orElse(null);
    }

    @Override
    public void setValue(BancoEntity value) {
        if (value == null) {
            setValueInteger(null);
        } else {
            setValueInteger(BigInteger.valueOf(value.getId()));
        }
    }

    @Override
    public FieldType getType() {
        return FieldType.ENTITY;
    }

    @Override
    public String getFilterSelection() {
        return "bancoFilterSelectAction";
    }

    @Override
    public int row() {
        return 5;
    }

    @Override
    public boolean isRequired() {
        return true;
    }
}
ParametroCentroCustoDefault.java:

@JArchParameter
public class ParametroCentroCustoDefault extends Parameter<CentroCustoEntity, ParametroFacade> {
    @Override
    public String system() {
        return BundleUtils.messageBundle("label.siglaSistema");
    }

    @Override
    public String category() {
        return BundleUtils.messageBundle("label.lancamento");
    }

    @Override
    public String description() {
        return BundleUtils.messageBundle("label.centroCustoDefault");
    }

    @Override
    public String explanation() {
        return BundleUtils.messageBundle("message.centroCustoDefaultLancamento");
    }

    @Override
    public CentroCustoEntity getValue() {
        if (getValueInteger() == null) {
            return null;
        }

        return CentroCustoJpqlBuilder
            .newInstance()
            .where()
            .equalsTo(CentroCustoEntity_.id, getValueInteger().longValue())
            .collect()
            .singleOptional()
            .orElse(null);
    }

    @Override
    public void setValue(CentroCustoEntity value) {
        if (value == null) {
            setValueInteger(null);
        } else {
            setValueInteger(BigInteger.valueOf(value.getId()));
        }
    }

    @Override
    public FieldType getType() {
        return FieldType.ENTITY;
    }

    @Override
    public String getFilterSelection() {
        return "centroCustoFilterSelectAction";
    }

    @Override
    public int row() {
        return 6;
    }

    @Override
    public boolean isRequired() {
        return true;
    }
}
ParametroCategoriaDefault.java:

@JArchParameter
public class ParametroCategoriaDefault extends Parameter<CentroCustoEntity, ParametroFacade> {
    @Override
    public String system() {
        return BundleUtils.messageBundle("label.siglaSistema");
    }

    @Override
    public String category() {
        return BundleUtils.messageBundle("label.lancamento");
    }

    @Override
    public String description() {
        return BundleUtils.messageBundle("label.centroCustoDefault");
    }

    @Override
    public String explanation() {
        return BundleUtils.messageBundle("message.centroCustoDefaultLancamento");
    }

    @Override
    public CentroCustoEntity getValue() {
        if (getValueInteger() == null) {
            return null;
        }

        return CentroCustoJpqlBuilder
            .newInstance()
            .where()
                .equalsTo(CentroCustoEntity_.id, getValueInteger().longValue())
            .collect()
            .singleOptional()
            .orElse(null);
    }

    @Override
    public void setValue(CentroCustoEntity value) {
        if (value == null) {
            setValueInteger(null);
        } else {
            setValueInteger(BigInteger.valueOf(value.getId()));
        }
    }

    @Override
    public FieldType getType() {
        return FieldType.ENTITY;
    }

    @Override
    public String getFilterSelection() {
        return "centroCustoFilterSelectAction";
    }

    @Override
    public int row() {
        return 7;
    }

    @Override
    public boolean isRequired() {
        return true;
    }
}
ParametroPessoaDefault.java:

@JArchParameter
public class ParametroPessoaDefault extends Parameter<PessoaEntity, ParametroFacade> {
    @Override
    public String system() {
        return BundleUtils.messageBundle("label.siglaSistema");
    }

    @Override
    public String category() {
        return BundleUtils.messageBundle("label.lancamento");
    }

    @Override
    public String description() {
        return BundleUtils.messageBundle("label.pessoaDefault");
    }

    @Override
    public String explanation() {
        return BundleUtils.messageBundle("message.pessoaDefaultLancamento");
    }

    @Override
    public PessoaEntity getValue() {
        if (getValueInteger() == null) {
            return null;
        }

        return PessoaJpqlBuilder
            .newInstance()
            .where()
                .equalsTo(PessoaEntity_.id, getValueInteger().longValue())
            .collect()
            .singleOptional()
            .orElse(null);
    }

    @Override
    public void setValue(PessoaEntity value) {
        if (value == null) {
            setValueInteger(null);
        } else {
            setValueInteger(BigInteger.valueOf(value.getId()));
        }
    }

    @Override
    public FieldType getType() {
        return FieldType.ENTITY;
    }

    @Override
    public String getFilterSelection() {
        return "pessoaFilterSelectAction";
    }

    @Override
    public int row() {
        return 8;
    }

    @Override
    public boolean isRequired() {
        return true;
    }
}
bundle_pt_BR.properties:
label.bancoDefault=Banco Default
label.centroCustoDefault=Centro Custo Default
label.categoriaDefault=Categoria Default
label.pessoaDefault=Pessoa Default
Agora executando novamente a tela de parâmetros:

Ajuste Evento Inclusão
O que preciso fazer agora é interceptar a inclusão de lançamento e setar o Banco, Centro Custo, Categoria e Pessoa com o que está configurado nos parâmetros. Então no LancamentoObserver faço a seguinte implementação:
LancamentoObserver.java:

public class LancamentoObserver {

   @JArchParameter
   @Inject
   private ParametroBancoDefault parametroBancoDefault;

   @JArchParameter
   @Inject
   private ParametroCentroCustoDefault parametroCentroCustoDefault;

   @JArchParameter
   @Inject
   private ParametroCategoriaDefault parametroCategoriaDefault;

   @JArchParameter
   @Inject
   private ParametroPessoaDefault parametroPessoaDefault;

   /** Código Ocultado **\

   private void criacaoLancamento(@Observes @JArchEventCreateEntity LancamentoEntity lancamento) {
      lancamento.setAberto(true);
      lancamento.setBanco(parametroBancoDefault.getValue());
      lancamento.setCentroCusto(parametroCentroCustoDefault.getValue());
      lancamento.setCategoria(parametroCategoriaDefault.getValue());
      lancamento.setPessoa(parametroPessoaDefault.getValue());
   }

   /** Código Ocultado **\
}
Agora no lançamento de uma conta a pagar ou receber temos:

Conclusão
Nesse post mostrei como utilizar um recurso muito importante na configuração da aplicação, a biblioteca de Parâmetros do JARCH. Para habilitar precisamos criar as classes concretas estendendo das classes do JARCH, e agora sempre que for necessário criar um parâmetro, basta criar uma classe estendendo da classe Parameter. Com certeza essa biblioteca vai atender todas as necessidades de parâmetros da aplicação, desde os tipos primitivos até tipos mais complexos como Classes, Imagens, etc. E na criação de um novo parâmetro não precisei mexer em banco de dados nem na interface gráfica, o JARCH já faz isso automaticamente. No próximo post explorarei mais recursos do JARCH.

Segue o link dessa video aula: https://youtu.be/eH2tAEFChm4

Até mais,
às

Nenhum comentário:

Postar um comentário

Assinar: Postar comentários (Atom)

Versão 23.3.0-Final

      Introdução Nesse post vou mostrar as principais novidades da versão 23.3.0, algumas correções e pequenas alterações. Alterações Além d...

  • Versão Final 21.11.0
    Introdução Nesse post vou mostrar as principais novidades da versão 21.11.0, algumas correções e pequenas alterações. Alterações Além das im...
  • Criando Estrutura de Versionamento de Scripts SQLs no Flyway
    Integração FLYWAY com JARCH   O   flyway   é uma excelente ferramenta para versionamento de scripts de banco de dados. Por padrão, ele utili...
  • Versão Final 21.9.0
      Introdução Nesse post vou mostrar as principais novidades da versão 21.9.0, algumas correções e pequenas alterações. Alterações Além das i...