PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface IOrcBSAcumuladosEconomica

    Motor dos acumulados por classificação económica

    Namespace: IOrcBS100
    Assembly: IOrcBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("9A8E2889-E140-4D12-B1CF-0422E2480152")]
    public interface IOrcBSAcumuladosEconomica

    Methods

    Actualiza(ref OrcBEAcumuladoEconomica, String)

    Procedimento para actualização.

    Declaration
    void Actualiza(ref OrcBEAcumuladoEconomica BEAcumuladoEconomica, string Avisos = "")
    Parameters
    Type Name Description
    OrcBEAcumuladoEconomica BEAcumuladoEconomica

    Objecto contendo a informação actualizada do acumulado classificação económica.

    System.String Avisos

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

    ActualizaContaIntegradora(ref OrcBEAcumuladoEconomica)

    Efectua a actualização da conta de integradora da classificação económica.

    Declaration
    void ActualizaContaIntegradora(ref OrcBEAcumuladoEconomica BEAcumuladoEconomica)
    Parameters
    Type Name Description
    OrcBEAcumuladoEconomica BEAcumuladoEconomica

    Objecto contendo a informação do acumulado da class. económica.

    ActualizaContaMovimento(ref OrcBEAcumuladoEconomica)

    Efectua a actualização da conta de movimento da classificação económica.

    Declaration
    void ActualizaContaMovimento(ref OrcBEAcumuladoEconomica BEAcumuladoEconomica)
    Parameters
    Type Name Description
    OrcBEAcumuladoEconomica BEAcumuladoEconomica

    Objecto contendo a informação do acumulado da class. económica.

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

    Actualiza o valor de um atributo.

    Declaration
    void ActualizaValorAtributo(int Ano, string ClassEcon, string Moeda, string Atributo, dynamic Valor)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    System.String ClassEcon

    Identificador da classificação economica.

    System.String Moeda

    Moeda.

    System.String Atributo

    Nome do atributo cujo valor será actualizado.

    System.Object Valor

    Valor do atributo que será actualizado.

    ActualizaValorAtributos(Int32, String, String, StdBECampos)

    Actualiza os valores respectivos de um conjunto de atributos.

    Declaration
    void ActualizaValorAtributos(int Ano, string ClassEcon, string Moeda, StdBECampos Atributos)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    System.String ClassEcon

    Identificador da classificação economica.

    System.String Moeda

    Moeda.

    StdBECampos Atributos

    Identifica os atributos e os respectivos valores a actualizar.

    ContaAnterior(Int32, ref String, String)

    Indica se determinada classificação económica tem conta anterior

    Declaration
    bool ContaAnterior(int Ano, ref string ClassEcon, string Moeda)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    System.String ClassEcon

    Classificação económica.

    System.String Moeda

    Moeda.

    Returns
    Type Description
    System.Boolean

    true caso tenha conta anterior, false caso contrário

    ContaTemMovimentos(Int32, ref String, String)

    Procedimento que valida se determinada classificação económica tem movimentos.

    Declaration
    bool ContaTemMovimentos(int Ano, ref string ClassEcon, string Moeda)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    System.String ClassEcon

    Classificação económica.

    System.String Moeda

    Moeda.

    Returns
    Type Description
    System.Boolean

    true caso tenha movimentos, false caso contrário

    criaContaRazao(Int32, String, String)

    Procedimento para criar conta de razão da classificação económica

    Declaration
    void criaContaRazao(int Ano, string ClassEcon, string Moeda)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    System.String ClassEcon

    Identificador da classificação economica.

    System.String Moeda

    Moeda.

    DaDefCamposUtil()

    Devolve as definições dos campos do utilizador.

    Declaration
    StdBEDefCamposUtil DaDefCamposUtil()
    Returns
    Type Description
    StdBEDefCamposUtil

    Definições dos campos do utilizador.

    DaDescricao(Int32, String, String)

    Devolve a descrição associada à classificação económica

    Declaration
    string DaDescricao(int Ano, string ClassEcon, string Moeda)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    System.String ClassEcon

    Identificador da classificação economica.

    System.String Moeda

    Moeda.

    Returns
    Type Description
    System.String

    Descrição da classificação económica

    DaValorAtributo(Int32, String, String, String)

    Devolve o valor de um atributo.

    Declaration
    dynamic DaValorAtributo(int Ano, string ClassEcon, string Moeda, string Atributo)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    System.String ClassEcon

    Identificador da classificação economica.

    System.String Moeda

    Moeda.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    Valor do atributo passado por parâmetro

    DaValorAtributoLock(Int32, String, String)

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

    Declaration
    dynamic DaValorAtributoLock(int Ano, string ClassEcon, string Atributo)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    System.String ClassEcon

    Identificador da classificação economica.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    Valor do atributo passado por parâmetro

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

    Devolve o valor de um conjunto de atributos de uma classificação económica.

    Declaration
    StdBECampos DaValorAtributos(int Ano, string ClassEcon, string Moeda, params dynamic[] Atributos)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    System.String ClassEcon

    Classificação económica.

    System.String Moeda

    Moeda.

    System.Object[] Atributos

    Conjunto de atributos dos quais se pretende devolver o valor.

    Returns
    Type Description
    StdBECampos

    Lista de atributos mapeados em objetos do tipo StdBECampo

    DaValorAtributosLock(Int32, String, String[])

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

    Declaration
    StdBECampos DaValorAtributosLock(int Ano, string ClassEcon, string[] Atributos)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    System.String ClassEcon

    Identificador da classificação economica.

    System.String[] Atributos

    Conjunto de atributos dos quais se pretende devolver o valor.

    Returns
    Type Description
    StdBECampos

    Lista de atributos mapeados em objetos do tipo StdBECampo

    Edita(Int32, String, String)

    Edição do acumulado da classificação económica.

    Declaration
    OrcBEAcumuladoEconomica Edita(int Ano, string ClassEcon, string Moeda)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    System.String ClassEcon

    Identificador da classificação economica.

    System.String Moeda

    Moeda.

    Returns
    Type Description
    OrcBEAcumuladoEconomica

    Objecto com a informação atualizada do acumulado da class. económica, para o ano passado por parâmetro.

    Existe(Int32, String, String)

    Verifica se o aumulado da classificação económica já existe.

    Declaration
    bool Existe(int Ano, string ClassEcon, string Moeda)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    System.String ClassEcon

    Classificação económica.

    System.String Moeda

    Moeda.

    Returns
    Type Description
    System.Boolean

    true se existe, false caso contrário

    Remove(Int32, String, String)

    Procedimento para remoção do acumulado da class. económica.

    Declaration
    void Remove(int Ano, string ClassEcon, string Moeda)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    System.String ClassEcon

    Identificador da classificação economica.

    System.String Moeda

    Moeda.

    ValidaActualizacao(OrcBEAcumuladoEconomica, ref String)

    Efectua a validação da informação dos acumulados da economica.

    Declaration
    bool ValidaActualizacao(OrcBEAcumuladoEconomica BEAcumuladoEconomica, ref string ErroValidacao)
    Parameters
    Type Name Description
    OrcBEAcumuladoEconomica BEAcumuladoEconomica

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

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detetados.

    Returns
    Type Description
    System.Boolean

    true caso a validação tenha sucedido, false caso contrário

    ValidaRemocao(Int32, String, String, String)

    Efectua as validações necessárias à remoção de acumulados de classificação economica.

    Declaration
    bool ValidaRemocao(int Ano, string ClassEcon, string Moeda, string ErroValidacao)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    System.String ClassEcon

    Identificador da classificação económica.

    System.String Moeda

    Moeda.

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detetados.

    Returns
    Type Description
    System.Boolean

    true caso a validação tenha sucedido, false caso contrário