SamDev - Métodos

Ultima Revisão: 20/07/2021

Conceito

Método é equivalente a uma função, subrotina ou procedimento escrito em uma certa linguagem de programação.


1 - obterEmpresaAtiva: Este método retorna um objeto do tipo Aac10 contendo os dados da empresa ativa.
        Disponibilidade: Fórmulas, Relatórios, Cubo, Interceptador, Script de Operações.

        Nome         : obterEmpresaAtiva()
        Exemplo : def aac10 = obterEmpresaAtiva()

2 - obterUsuarioLogadoEste método retorna um objeto do tipo Aab10 contendo os dados do usuário logado.
        Disponibilidade: Fórmulas, Relatórios, Cubo, Interceptador, Script de Operações.

        Nome         : obterUsuarioLogado()
        Exemplo : def aab10 = obterUsuarioLogado()

3 - obterWherePadrao: Este método retorna um WHERE filtrando pelos Campos Default para ser utilizado em SQLs.
        Disponibilidade: Fórmulas, Relatórios, Cubo, Interceptador, Script de Operações.

        Nome                  obterWherePadrao(Argumento1, Argumento2)
        Argumento1    : Nome da tabela
        Argumento2    : Comparador [WHERE, AND, OR, etc]

        Exemplo           : "SELECT * FROM Abe01 " + obterWherePadrao("Abe01", "WHERE")

4 - getAcessoAoBanco(): Este método retorna uma coleção de métodos uteis para manipulação do banco de dados descritos a baixo:
        Disponibilidade: Fórmulas, Relatórios, Cubo, Interceptador, Script de Operações.

4.1 - buscarListaDeTableMap: Este métodos retorna uma lista de TableMap contendo os registros obtidos a partir da execução de uma SQL.

        Nome                  buscarListaDeTableMap(Argumento1)
        Argumento1    : SQL a ser executada

        Exemplo           : getAcessoAoBanco().buscarListaDeTableMap(sql) 

4.2 - buscarUnicoTableMap:  Este métodos retorna um único TableMap contendo o registro obtido a partir da execução de uma SQL.

        Nome                  buscarUnicoTableMap(Argumento1)
        Argumento1    : SQL a ser executada

        Exemplo           : getAcessoAoBanco().buscarUnicoTableMap(sql) 

4.3 - buscarListaDeRegistros: Este métodos retorna uma lista de Registros obtidos a partir da execução de uma SQL.

        Nome                  buscarListaDeRegistros(Argumento1)
        Argumento1    : SQL a ser executada

        Exemplo           : getAcessoAoBanco().buscarListaDeRegistros(sql) 

4.4 - buscarRegistroUnico:  Este métodos retorna um único Registro obtido a partir da execução de uma SQL.

        Nome                  buscarRegistroUnico(Argumento1)
        Argumento1    : SQL a ser executada

        Exemplo           : getAcessoAoBanco().buscarRegistroUnico(sql) 

4.5 - buscarMultiResultSet: Este métodos retorna um objeto do tipo MultiResultSet contendo os registros obtidos a partir da execução de uma SQL.

        Nome                  buscarMultiResultSet(Argumento1)
        Argumento1    : SQL a ser executada

        Exemplo           : getAcessoAoBanco().buscarMultiResultSet(sql) 

4.6 - obterListaDeBigDecimal:  Este métodos retorna uma lista de Decimais obtidos a partir da execução de uma SQL.

        Nome                  obterListaDeBigDecimal(Argumento1)
        Argumento1    : SQL a ser executada

        Exemplo           : getAcessoAoBanco().obterListaDeBigDecimal(sql) 

4.7 - obterBigDecimal: Este métodos retorna um Decimal obtido a partir da execução de uma SQL.

        Nome                  obterBigDecimal(Argumento1)
        Argumento1    : SQL a ser executada

        Exemplo           : getAcessoAoBanco().obterBigDecimal(sql) 

4.8 - obterListaDeInteger: Este métodos retorna uma lista de Inteiros obtidos a partir da execução de uma SQL.

        Nome                  obterListaDeInteger(Argumento1)
        Argumento1    : SQL a ser executada

        Exemplo           : getAcessoAoBanco().obterListaDeInteger(sql) 

4.9 - obterInteger: Este métodos retorna um Inteiro obtido a partir da execução de uma SQL.

        Nome                  obterInteger(Argumento1)
        Argumento1    : SQL a ser executada

        Exemplo           : getAcessoAoBanco().obterInteger(sql) 

4.10 - obterListaDeDate: Este métodos retorna uma lista de Datas obtidas a partir da execução de uma SQL.

        Nome                  obterListaDeDate(Argumento1)
        Argumento1    : SQL a ser executada

        Exemplo           : getAcessoAoBanco().obterListaDeDate(sql) 

4.11 - obterDate: Este métodos retorna uma data obtida a partir da execução de uma SQL.

        Nome                  obterDate(Argumento1)
        Argumento1    : SQL a ser executada

        Exemplo           : getAcessoAoBanco().obterDate(sql) 

4.12 - obterListaDeString: Este métodos retorna uma lista de Textos obtidos a partir da execução de uma SQL.

        Nome                  obterListaDeString(Argumento1)
        Argumento1    : SQL a ser executada

        Exemplo           : getAcessoAoBanco().obterListaDeString(sql) 

4.13 - obterString: Este métodos retorna um Texto obtido a partir da execução de uma SQL.

        Nome                  obterString(Argumento1)
        Argumento1    : SQL a ser executada

        Exemplo           : getAcessoAoBanco().obterString(sql) 

4.14 - obterListaDeLong: Este métodos retorna uma lista de Longos obtidos a partir da execução de uma SQL.

        Nome                  obterListaDeLong(Argumento1)
        Argumento1    : SQL a ser executada

        Exemplo           : getAcessoAoBanco().obterListaDeLong(sql) 

4.15 - obterLong: Este métodos retorna um Longo obtido a partir da execução de uma SQL.

        Nome                  obterLong(Argumento1)
        Argumento1    : SQL a ser executada

        Exemplo           : getAcessoAoBanco().obterLong(sql) 

4.16 - obterCount: Este métodos retorna uma contagem de registro obtidos a partir da execução de uma SQL.

        Nome                  obterCount(Argumento1)
        Argumento1    : SQL a ser executada

        Exemplo           : getAcessoAoBanco().obterCount(sql) 

4.17 - buscarRegistroUnicoById: Este método retorna um registro pelo id informado como argumento.

        Nome                  buscarRegistroUnicoById(Argumento1, Argumento2)
        Argumento1    : Nome da tabela
        Argumento2    : ID do registro

        Exemplo           : getAcessoAoBanco().buscarRegistroUnicoById("Aac10", 1000) 

4.18 - obterEmpresa: Este método retorna um objeto do tipo Aac10 contendo todas as tabelas filhas e FKs a partir de um ID.

        Nome                  obterEmpresa(Argumento1)
        Argumento1    : ID do registro

        Exemplo           : getAcessoAoBanco().obterEmpresa(1000) 

5 - selecionarAlinhamento: Este método seleciona qual alinhamento de valores será utilizado no script.
        Disponibilidade: Fórmulas, Relatórios.

        Nome                  selecionarAlinhamento(Argumento1)
        Argumento1    : Código do alinhamento de valores

        Exemplo           selecionarAlinhamento("9999") 

6 - getCampo: Este método retorna o campo informado no alinhamento de valores pelo conteúdo do registro.
        Disponibilidade: Fórmulas, Relatórios.

        Nome                  getCampo(Argumento1, Argumento2)
        Argumento1    : Registro
        Argumento1    : Campo

     Exemplo     getCampo("C100", "ICMS")