PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface IOrcBSExercicios

    Motor da gestão de exercícios orçamentais

    Namespace: IOrcBS100
    Assembly: IOrcBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("0AB41FB6-A8EE-4E29-9DA3-7E62104ED087")]
    public interface IOrcBSExercicios

    Methods

    Actualiza(OrcBEExercicio, String)

    Procedimento para actualização.

    Declaration
    dynamic Actualiza(OrcBEExercicio BEExercicio, string Avisos = "")
    Parameters
    Type Name Description
    OrcBEExercicio BEExercicio

    Objecto contendo a informação actualizada dos parâmetros de exercício.

    System.String Avisos

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

    Returns
    Type Description
    System.Object

    DaDefCamposUtil()

    Devolve as definições dos campos do utilizador.

    Declaration
    StdBEDefCamposUtil DaDefCamposUtil()
    Returns
    Type Description
    StdBEDefCamposUtil

    Definições dos campos do utilizador.

    DaNaturezaValidacao(Int32, String)

    Devolve a natureza da validação de uma determinada conta.

    Declaration
    string DaNaturezaValidacao(int Exercicio, string Conta)
    Parameters
    Type Name Description
    System.Int32 Exercicio
    System.String Conta

    Conta financeira

    Returns
    Type Description
    System.String

    DaPrimeiroAno()

    Devolve o primeiro criado.

    Declaration
    int DaPrimeiroAno()
    Returns
    Type Description
    System.Int32

    DaUltimoAno()

    Devolve o último criado.

    Declaration
    int DaUltimoAno()
    Returns
    Type Description
    System.Int32

    DaValorAtributo(Int32, String)

    Actualiza o valor de um atributo.

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

    Ano do exercício.

    System.String Atributo

    Nome do atributo cujo valor será actualizado.

    Returns
    Type Description
    System.Object

    DaValorAtributoLock(Int32, String)

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

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

    Ano do exercício.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    Valor do atributo passado por parâmetro

    DaValorAtributos(Int32, Object[])

    Actualiza os valores respectivos de um conjunto de atributos.

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

    Ano do exercício.

    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[])

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

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

    Ano do exercício.

    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)

    Edição dos parâmetros de um exercício

    Declaration
    OrcBEExercicio Edita(int Ano)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    Returns
    Type Description
    OrcBEExercicio

    Existe(Int32)

    Verifica se já existe o exercício.

    Declaration
    bool Existe(int Ano)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    Returns
    Type Description
    System.Boolean

    true se existe, false caso contrário

    LstExercicios()

    Listagem dos parâmetros de exercício

    Declaration
    StdBELista LstExercicios()
    Returns
    Type Description
    StdBELista

    ValidaActualizacao(OrcBEExercicio, ref String)

    Efectua a validação da informação dos parâmetros de exercício.

    Declaration
    bool ValidaActualizacao(OrcBEExercicio BEExercicio, ref string ErroValidacao)
    Parameters
    Type Name Description
    OrcBEExercicio BEExercicio

    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