PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface ICblBSRelatorios

    Namespace: ICblBS100
    Assembly: ICblBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("AE14549C-B61B-4D99-AF9A-8F476BCC52CC")]
    public interface ICblBSRelatorios

    Methods

    Actualiza(CblBERelatorio, String)

    Actualiza a informação do Relatorio.

    Declaration
    void Actualiza(CblBERelatorio objRelatorio, string Avisos = "")
    Parameters
    Type Name Description
    CblBERelatorio objRelatorio

    Objecto contendo a informação actualizada do Relatorio.

    System.String Avisos

    Notificação devolvida pelo processo de actualização.

    ActualizaExercicios(String, CblBEEmpresasRelatorio)

    Actualiza Exercício.

    Declaration
    void ActualizaExercicios(string IdRelatorio, CblBEEmpresasRelatorio objExercicios)
    Parameters
    Type Name Description
    System.String IdRelatorio

    Identificador do Relatório.

    CblBEEmpresasRelatorio objExercicios

    Objecto com a informação a ser actualizada.

    ActualizaLocalizacoes(String, CblBELocalizacoesRelatorio)

    Actualiza Localizações.

    Declaration
    void ActualizaLocalizacoes(string IdRelatorio, CblBELocalizacoesRelatorio objLocalizacoes)
    Parameters
    Type Name Description
    System.String IdRelatorio

    Identificador do Relatório.

    CblBELocalizacoesRelatorio objLocalizacoes

    Objecto com a informação a ser actualizada.

    ActualizaValorAtributo(String, String, Object)

    Actualiza o valor de um atributo.

    Declaration
    void ActualizaValorAtributo(string IdRelatorio, string Atributo, dynamic Valor)
    Parameters
    Type Name Description
    System.String IdRelatorio

    Identificador do Relatorio.

    System.String Atributo

    Nome do atributo cujo valor será actualizado.

    System.Object Valor

    Valor do atributo que será actualizado.

    ActualizaValorAtributos(String, StdBECampos)

    Actualiza os valores respectivos de um conjunto de atributos.

    Declaration
    void ActualizaValorAtributos(string IdRelatorio, StdBECampos Atributos)
    Parameters
    Type Name Description
    System.String IdRelatorio

    Identificador do Relatorio.

    StdBECampos Atributos

    Identifica os atributos e os respectivos valores a actualizar.

    DaDefCamposUtil()

    Devolve as definições dos campos do utilizador.

    Declaration
    StdBEDefCamposUtil DaDefCamposUtil()
    Returns
    Type Description
    StdBEDefCamposUtil

    DaValorAtributo(String, String)

    Devolve o valor de um atributo.

    Declaration
    dynamic DaValorAtributo(string IdRelatorio, string Atributo)
    Parameters
    Type Name Description
    System.String IdRelatorio

    Identificador do Relatorio.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributoLock(String, String)

    Devolve o valor de um atributo, respeitando os locks da base de dados.

    Declaration
    dynamic DaValorAtributoLock(string IdRelatorio, string Atributo)
    Parameters
    Type Name Description
    System.String IdRelatorio

    Identificador do Relatorio.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributos(String, Object[])

    Devolve o valor de um conjunto de atributos.

    Declaration
    StdBECampos DaValorAtributos(string IdRelatorio, params dynamic[] Atributos)
    Parameters
    Type Name Description
    System.String IdRelatorio

    Identificador do Relatorio.

    System.Object[] Atributos

    Conjunto de atributos dos quais se pretende devolver o valor.

    Returns
    Type Description
    StdBECampos

    DaValorAtributosLock(String, Object[])

    Devolve o valor de um conjunto de atributos, respeitando os locks da base de dados.

    Declaration
    StdBECampos DaValorAtributosLock(string IdRelatorio, params dynamic[] Atributos)
    Parameters
    Type Name Description
    System.String IdRelatorio

    Identificador do Relatorio.

    System.Object[] Atributos

    Conjunto de atributos dos quais se pretende devolver o valor.

    Returns
    Type Description
    StdBECampos

    DuplicaRelatorio(String, String, String)

    Função que permite a duplicação do Relatório.

    Declaration
    void DuplicaRelatorio(string IdRelatorio, string strNomeNovoRelatorio, string strNomeNovaTemplate)
    Parameters
    Type Name Description
    System.String IdRelatorio

    Identificador do Relatório a ser duplicado.

    System.String strNomeNovoRelatorio

    Identificador do nome do novo Relatório.

    System.String strNomeNovaTemplate

    Identificador do nome da nova Template.

    Edita(String)

    Edita a informação do Relatorio.

    Declaration
    CblBERelatorio Edita(string IdRelatorio)
    Parameters
    Type Name Description
    System.String IdRelatorio

    Identificador do Relatorio.

    Returns
    Type Description
    CblBERelatorio

    EditaParametros(String)

    Função que retorna os parametros do relatório.

    Declaration
    CblBEParametrosRelatorio EditaParametros(string IdRelatorio)
    Parameters
    Type Name Description
    System.String IdRelatorio

    Identificador do Relatório.

    Returns
    Type Description
    CblBEParametrosRelatorio

    Existe(String)

    Verifica se existe o Relatorio.

    Declaration
    bool Existe(string IdRelatorio)
    Parameters
    Type Name Description
    System.String IdRelatorio

    Identificador do Relatorio.

    Returns
    Type Description
    System.Boolean

    LstExercicios(String)

    Listagem de Exercícios por relatório.

    Declaration
    StdBELista LstExercicios(string IdRelatorio)
    Parameters
    Type Name Description
    System.String IdRelatorio

    Identificador do Relatório.

    Returns
    Type Description
    StdBELista

    LstLocalizacoes(String)

    Listagem de localizações por relatório.

    Declaration
    StdBELista LstLocalizacoes(string IdRelatorio)
    Parameters
    Type Name Description
    System.String IdRelatorio

    Identificador do Relatório.

    Returns
    Type Description
    StdBELista

    LstRelatoriosExercicio(StdBETipos.EnumTipoExercicio, StdBETipos.EnumLocalizacaoSede)

    Listagem dos relatórios por Tipo de Exercicio.

    Declaration
    StdBELista LstRelatoriosExercicio(StdBETipos.EnumTipoExercicio TipoExercicio, StdBETipos.EnumLocalizacaoSede Localizacao)
    Parameters
    Type Name Description
    StdBETipos.EnumTipoExercicio TipoExercicio

    Identificador do Tipo de Exercicio.

    StdBETipos.EnumLocalizacaoSede Localizacao

    Identificador da Localização da Sede.

    Returns
    Type Description
    StdBELista

    ParseParametros(CblBEVariaveisRelatorio)

    Função de verificação de parametros.

    Declaration
    CblBEParametrosRelatorio ParseParametros(CblBEVariaveisRelatorio objVarsRelatorio)
    Parameters
    Type Name Description
    CblBEVariaveisRelatorio objVarsRelatorio

    Objecto com a informação das variaveis do relatório.

    Returns
    Type Description
    CblBEParametrosRelatorio

    ParseVariaveis(String, CblBEParametrosRelatorio)

    Função de verificação de variáveis.

    Declaration
    CblBEVariaveisRelatorio ParseVariaveis(string IdRelatorio, CblBEParametrosRelatorio objParamsRelatorio)
    Parameters
    Type Name Description
    System.String IdRelatorio

    Identificador do Relatório.

    CblBEParametrosRelatorio objParamsRelatorio
    Returns
    Type Description
    CblBEVariaveisRelatorio

    Remove(String)

    Remove o Relatorio.

    Declaration
    void Remove(string IdRelatorio)
    Parameters
    Type Name Description
    System.String IdRelatorio

    Identificador do Relatorio.

    ValidaActualizacao(CblBERelatorio, ref String)

    Efectua a validação da informação do Relatorio.

    Declaration
    bool ValidaActualizacao(CblBERelatorio objRelatorio, ref string StrErro)
    Parameters
    Type Name Description
    CblBERelatorio objRelatorio

    Objecto contendo a informação que se pretende validar.

    System.String StrErro
    Returns
    Type Description
    System.Boolean

    ValidaRemocao(String, ref String)

    Efectua as validações necessárias à remoção do Relatorio.

    Declaration
    bool ValidaRemocao(string IdRelatorio, ref string StrErro)
    Parameters
    Type Name Description
    System.String IdRelatorio

    Identificador do Relatorio.

    System.String StrErro
    Returns
    Type Description
    System.Boolean