PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface ICblBSTiposDocControlling

    Classe utilizada para obter serviços e regras de negócio sobre Tipos de Documento de Controlling.

    Namespace: ICblBS100
    Assembly: ICblBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("97A10675-A80D-4A78-810C-54218A70480A")]
    public interface ICblBSTiposDocControlling

    Methods

    Actualiza(CblBETipoDocControlling)

    Actualiza o Tipo de Documento de Controlling na base de dados.

    Declaration
    void Actualiza(CblBETipoDocControlling objTipoDocControlling)
    Parameters
    Type Name Description
    CblBETipoDocControlling objTipoDocControlling

    Objecto que identifica o Tipo de Documento a actualizar

    ActualizaNumerador(Int32, String, String, Int32)

    Actualiza Numerador dos Tipos de Documentos de Controlling.

    Declaration
    void ActualizaNumerador(int Ano, string TipoLancamento, string Documento, int Numero)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do Numerador.

    System.String TipoLancamento

    Tipo de Lançamento.

    System.String Documento

    Identificação do tipo de documento.

    System.Int32 Numero

    Valor actualizado do Numerador.

    ActualizaValorAtributo(String, String, Object)

    Permite efectuar a actualização de um atributo de um determinado Tipo de Documento de Controlling.

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

    Identificador do tipo de documento.

    System.String Atributo

    Nome do campo a actualizar

    System.Object Valor

    Valor do campo a actualizar

    ActualizaValorAtributos(String, StdBECampos)

    Permite efectuar a actualização de um conjunto de atributos de um determinado Tipo de Documento de Controlling.

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

    Identificador do tipo de documento.

    StdBECampos Atributos

    Atributos e respectivos valores a actualizar

    DaDefCamposUtil()

    Devolve as definições dos campos do utilizador.

    Declaration
    StdBEDefCamposUtil DaDefCamposUtil()
    Returns
    Type Description
    StdBEDefCamposUtil

    DaNumerador(Int32, String, String)

    Dá Numerador para o próximo Tipos de Documentos de Controlling.

    Declaration
    int DaNumerador(int Ano, string TipoLancamento, string Documento)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do Numerador.

    System.String TipoLancamento

    Tipo de Lançamento.

    System.String Documento

    Identificação do tipo de documento.

    Returns
    Type Description
    System.Int32

    DaValorAtributo(String, String)

    Devolve o valor de um atributo de um determinado Tipo de Documento de Controlling.

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

    Identificador do tipo de documento.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributoLock(String, String)

    Devolve o valor de um atributo de um determinado Tipo de Documento de Controlling, respeitando os locks da base de dados.

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

    Identificador do tipo de documento.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributos(String, String[])

    Devolve os valores de um conjunto de atributos de um determinado Tipo de Documento de Controlling.

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

    Identificador do tipo de documento.

    System.String[] Atributos

    Atributos para os quais se pretende devolver os valores

    Returns
    Type Description
    StdBECampos

    DaValorAtributosLock(String, String[])

    Devolve os valores de um conjunto de atributos de um determinado Tipo de Documento de Controlling, respeitando os locks da base de dados.

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

    Identificador do tipo de documento.

    System.String[] Atributos

    Atributos para os quais se pretende devolver os valores

    Returns
    Type Description
    StdBECampos

    DocumentoEmUso(String)

    Valida se o documento já foi usado no registo de algum documento de controlling.

    Declaration
    bool DocumentoEmUso(string Documento)
    Parameters
    Type Name Description
    System.String Documento

    Identificação do tipo de documento.

    Returns
    Type Description
    System.Boolean

    Edita(String, Int32, String)

    Edita a informação associada a um determinado Tipo de Documento de Controlling.

    Declaration
    CblBETipoDocControlling Edita(string TipoLancamento, int Ano, string Documento)
    Parameters
    Type Name Description
    System.String TipoLancamento
    System.Int32 Ano
    System.String Documento

    Identificador do tipo de documento.

    Returns
    Type Description
    CblBETipoDocControlling

    Existe(String)

    Verifica se o Tipo de Documento de Controlling existe num determinado ano na base de dados.

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

    Identificador do tipo de documento.

    Returns
    Type Description
    System.Boolean

    ExisteAno(String, Int32, String)

    Verifica se o Tipo de Documento de Controlling existe num determinado ano na base de dados.

    Declaration
    bool ExisteAno(string TipoLancamento, int Ano, string Documento)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Tipo de Lançamento.

    System.Int32 Ano

    Ano do Numerador.

    System.String Documento

    Identificação do tipo de documento.

    Returns
    Type Description
    System.Boolean

    LstTiposDocControlling()

    Devolve a listagem dos Tipos de Documento de Controlling.

    Declaration
    StdBELista LstTiposDocControlling()
    Returns
    Type Description
    StdBELista

    Remove(String)

    Remove toda a informação associada a um determinado Tipo de Documento de Controlling.

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

    Identificador do tipo de documento.

    ValidaActualizacao(CblBETipoDocControlling, ref String)

    Efectua as validações necessárias à actualização de um determinado Tipo de Documento de Controlling.

    Declaration
    bool ValidaActualizacao(CblBETipoDocControlling objTipoDocControlling, ref string StrErro)
    Parameters
    Type Name Description
    CblBETipoDocControlling objTipoDocControlling
    System.String StrErro

    Descrição de erro devolvida pela função

    Returns
    Type Description
    System.Boolean

    ValidaRemocao(String, String)

    Efectua as validações necessárias à remoção de um determinado Tipo de Documento de Controlling.

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

    Identificador do tipo de documento.

    System.String StrErro

    Descrição de erro devolvida pela função

    Returns
    Type Description
    System.Boolean