PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface IRhpBSRelatoriosSHST

    Classe utilizada para obter as regras de negócio do Relatório de SHST.

    Namespace: IRhpBS100
    Assembly: IRhpBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("AC2FA344-5571-4157-9F16-0759E581EDFE")]
    public interface IRhpBSRelatoriosSHST

    Methods

    Actualiza(RhpBERelatorioSHST)

    Actualiza a informação do relatório Anual do SHST.

    Declaration
    void Actualiza(RhpBERelatorioSHST objRelatorioSHST)
    Parameters
    Type Name Description
    RhpBERelatorioSHST objRelatorioSHST

    Objecto contendo os valores actuais.

    ActualizaValorAtributo(Int32, String, String, Int32, String, String, Object)

    Actualiza o valor de um atributo.

    Declaration
    void ActualizaValorAtributo(int Ano, string Estabelecimento, string TipoRegisto, int Linha, string Campo, string Atributo, object Valor)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do relatório.

    System.String Estabelecimento

    Estabelecimento do relatório

    System.String TipoRegisto

    Tipo de registo do campo do relatório

    System.Int32 Linha

    Linha do campo do relatório

    System.String Campo

    Campo do relatório

    System.String Atributo

    Nome do atributo cujo valor será actualizado.

    System.Object Valor

    Novo valor do atributo indicado.

    ActualizaValorAtributos(Int32, String, String, Int32, String, StdBECampos)

    Actualiza os valores respectivos de um conjunto de atributos.

    Declaration
    void ActualizaValorAtributos(int Ano, string Estabelecimento, string TipoRegisto, int Linha, string Campo, StdBECampos Atributos)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do relatório.

    System.String Estabelecimento

    Estabelecimento do relatório

    System.String TipoRegisto

    Tipo de registo do campo do relatório

    System.Int32 Linha

    Linha do campo do relatório

    System.String Campo

    Campo do relatório

    StdBECampos Atributos

    Objecto contendo os atributos a actualizar e respectivos valores.

    DaDefCamposUtil()

    Devolve as definições dos campos do utilizador.

    Declaration
    StdBEDefCamposUtil DaDefCamposUtil()
    Returns
    Type Description
    StdBEDefCamposUtil

    DaValorAtributo(Int32, String, String, Int32, String, String)

    Devolve o valor de um atributo.

    Declaration
    object DaValorAtributo(int Ano, string Estabelecimento, string TipoRegisto, int Linha, string Campo, string Atributo)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do relatório.

    System.String Estabelecimento

    Estabelecimento do relatório

    System.String TipoRegisto

    Tipo de registo do campo do relatório

    System.Int32 Linha

    Linha do campo do relatório

    System.String Campo

    Campo do relatório

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributos(Int32, String, String, Int32, String, String[])

    Devolve o valor de um conjunto de atributos.

    Declaration
    StdBECampos DaValorAtributos(int Ano, string Estabelecimento, string TipoRegisto, int Linha, string Campo, params string[] Atributos)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do relatório.

    System.String Estabelecimento

    Estabelecimento do relatório

    System.String TipoRegisto

    Tipo de registo do campo do relatório

    System.Int32 Linha

    Linha do campo do relatório

    System.String Campo

    Campo do relatório

    System.String[] Atributos

    Conjunto de atributos dos quais se pretende devolver o valor.

    Returns
    Type Description
    StdBECampos

    Edita(Int32, String, String, Int32, String)

    Edita a informação de uma linha do relatório

    Declaration
    RhpBEIntervencaoMedida Edita(int Ano, string Estabelecimento, string TipoRegisto, int Linha, string Campo)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do relatório.

    System.String Estabelecimento

    Estabelecimento do relatório

    System.String TipoRegisto

    Tipo de registo do campo do relatório

    System.Int32 Linha

    Linha do campo do relatório

    System.String Campo

    Campo do relatório

    Returns
    Type Description
    RhpBEIntervencaoMedida

    Existe(Int32, String, String, Int32, String)

    Verifica se existe o registo referente à informação passada nos parâmetros.

    Declaration
    bool Existe(int Ano, string Estabelecimento, string TipoRegisto, int Linha, string Campo)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do relatório.

    System.String Estabelecimento

    Estabelecimento do relatório

    System.String TipoRegisto

    Tipo de registo do campo do relatório

    System.Int32 Linha

    Linha do campo do relatório

    System.String Campo

    Campo do relatório

    Returns
    Type Description
    System.Boolean

    Remove(Int32, String, String, Int32, String)

    Remove uma linha do campo do relatório

    Declaration
    void Remove(int Ano, string Estabelecimento, string TipoRegisto, int Linha, string Campo)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do relatório.

    System.String Estabelecimento

    Estabelecimento do relatório

    System.String TipoRegisto

    Tipo de registo do campo do relatório

    System.Int32 Linha

    Linha do campo do relatório

    System.String Campo

    Campo do relatório

    ValidaActualizacao(RhpBERelatorioSHST, ref String)

    Efectua a validação dos dados relativos ao relatório de SHST.

    Declaration
    bool ValidaActualizacao(RhpBERelatorioSHST objRelatorioSHST, ref string ErroValidacao)
    Parameters
    Type Name Description
    RhpBERelatorioSHST objRelatorioSHST

    Objecto contendo os novos valores a actualizar.

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detectados.

    Returns
    Type Description
    System.Boolean

    ValidaRemocao(Int32, String, String, Int32, String, ref String)

    Efectua a validação de um registo antes de ser efectuada a sua remoção.

    Declaration
    bool ValidaRemocao(int Ano, string Estabelecimento, string TipoRegisto, int Linha, string Campo, ref string ErroValidacao)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do relatório.

    System.String Estabelecimento

    Estabelecimento do relatório

    System.String TipoRegisto

    Tipo de registo do campo do relatório

    System.Int32 Linha

    Linha do campo do relatório

    System.String Campo

    Campo do relatório

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detectados.

    Returns
    Type Description
    System.Boolean