PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface ICnoBSDocumentos

    Classe utilizada para obter serviços e regras de negócio sobre documentos.

    Namespace: ICnoBS100
    Assembly: ICnoBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("CB89DD24-C05C-462D-B7F8-E3D18AB2D0F9")]
    public interface ICnoBSDocumentos

    Methods

    Actualiza(CnoBEDocumento, String)

    Actualiza a informação de documentos.

    Declaration
    void Actualiza(CnoBEDocumento objBE, string strAvisos = "")
    Parameters
    Type Name Description
    CnoBEDocumento objBE
    System.String strAvisos

    actualizaContador(Int32)

    Actualiza contador dos documentos.

    Declaration
    void actualizaContador(int iAno)
    Parameters
    Type Name Description
    System.Int32 iAno

    actualizaNumerador(Int32, String, Int32)

    Actualiza numerador de documentos.

    Declaration
    void actualizaNumerador(int iAno, string strCodigoLivro, int lngNumerador)
    Parameters
    Type Name Description
    System.Int32 iAno
    System.String strCodigoLivro
    System.Int32 lngNumerador

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

    Actualiza o valor de um atributo.

    Declaration
    void ActualizaValorAtributo(int Ano, string Livro, int NumeroMov, string Atributo, dynamic Valor)
    Parameters
    Type Name Description
    System.Int32 Ano
    System.String Livro
    System.Int32 NumeroMov
    System.String Atributo
    System.Object Valor

    ActualizaValorAtributoID(String, String, Object)

    Actualiza o valor de um atributo.

    Declaration
    void ActualizaValorAtributoID(string ID, string Atributo, dynamic Valor)
    Parameters
    Type Name Description
    System.String ID
    System.String Atributo
    System.Object Valor

    ActualizaValorAtributos(Int32, String, Int32, StdBECampos)

    Actualiza os valores respectivos de um conjunto de atributos.

    Declaration
    void ActualizaValorAtributos(int Ano, string Livro, int NumeroMov, StdBECampos Atributos)
    Parameters
    Type Name Description
    System.Int32 Ano
    System.String Livro
    System.Int32 NumeroMov
    StdBECampos Atributos

    ActualizaValorAtributosID(String, StdBECampos)

    Actualiza os valores respectivos de um conjunto de atributos.

    Declaration
    void ActualizaValorAtributosID(string ID, StdBECampos Atributos)
    Parameters
    Type Name Description
    System.String ID
    StdBECampos Atributos

    DaDefCamposUtil()

    Devolve as definições dos campos do utilizador.

    Declaration
    StdBEDefCamposUtil DaDefCamposUtil()
    Returns
    Type Description
    StdBEDefCamposUtil

    DaDefCamposUtilLinhasDocumento()

    Devolve as definições dos campos do utilizador para as linhas do documento.

    Declaration
    StdBEDefCamposUtil DaDefCamposUtilLinhasDocumento()
    Returns
    Type Description
    StdBEDefCamposUtil

    daProximoContador(Int32)

    Devolve o número do próximo contador.

    Declaration
    int daProximoContador(int iAno)
    Parameters
    Type Name Description
    System.Int32 iAno
    Returns
    Type Description
    System.Int32

    daProximoNumerador(Int32, String)

    Devolve o próximo numerador.

    Declaration
    int daProximoNumerador(int iAno, string strCodigoLivro)
    Parameters
    Type Name Description
    System.Int32 iAno
    System.String strCodigoLivro
    Returns
    Type Description
    System.Int32

    DaProximoNumMov(Int32, String, String)

    Devolve o número do próximo movimento.

    Declaration
    int DaProximoNumMov(int iAno, string sLivro, string sRubrica)
    Parameters
    Type Name Description
    System.Int32 iAno
    System.String sLivro
    System.String sRubrica
    Returns
    Type Description
    System.Int32

    daUltimaData(Int32, String)

    Devolve a última data dos documentos.

    Declaration
    DateTime daUltimaData(int iAno, string sLivro)
    Parameters
    Type Name Description
    System.Int32 iAno
    System.String sLivro
    Returns
    Type Description
    System.DateTime

    DaValorAtributo(Int32, String, Int32, String)

    Devolve o valor de um atributo.

    Declaration
    dynamic DaValorAtributo(int Ano, string Livro, int NumeroMov, string Atributo)
    Parameters
    Type Name Description
    System.Int32 Ano
    System.String Livro
    System.Int32 NumeroMov
    System.String Atributo
    Returns
    Type Description
    System.Object

    DaValorAtributoID(String, String)

    Devolve o valor de um atributo.

    Declaration
    dynamic DaValorAtributoID(string ID, string Atributo)
    Parameters
    Type Name Description
    System.String ID
    System.String Atributo
    Returns
    Type Description
    System.Object

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

    Devolve o valor de um conjunto de atributos.

    Declaration
    StdBECampos DaValorAtributos(int Ano, string Livro, int NumeroMov, params dynamic[] Atributos)
    Parameters
    Type Name Description
    System.Int32 Ano
    System.String Livro
    System.Int32 NumeroMov
    System.Object[] Atributos
    Returns
    Type Description
    StdBECampos

    DaValorAtributosID(String, Object[])

    Devolve o valor de um conjunto de atributos.

    Declaration
    StdBECampos DaValorAtributosID(string ID, params dynamic[] Atributos)
    Parameters
    Type Name Description
    System.String ID
    System.Object[] Atributos
    Returns
    Type Description
    StdBECampos

    Edita(Int32, String, Int32)

    Edita a informação do documento.

    Declaration
    CnoBEDocumento Edita(int Ano, string Livro, int NumeroMov)
    Parameters
    Type Name Description
    System.Int32 Ano
    System.String Livro
    System.Int32 NumeroMov
    Returns
    Type Description
    CnoBEDocumento

    EditaID(String)

    Edita a informação do documento.

    Declaration
    CnoBEDocumento EditaID(string ID)
    Parameters
    Type Name Description
    System.String ID
    Returns
    Type Description
    CnoBEDocumento

    Existe(Int32, String, Int32)

    Verifica se existe o documento.

    Declaration
    bool Existe(int Ano, string Livro, int NumeroMov)
    Parameters
    Type Name Description
    System.Int32 Ano
    System.String Livro
    System.Int32 NumeroMov
    Returns
    Type Description
    System.Boolean

    ExisteID(String)

    Verifica se existe o documento.

    Declaration
    bool ExisteID(string ID)
    Parameters
    Type Name Description
    System.String ID
    Returns
    Type Description
    System.Boolean

    lstDocumentosLivro(String, Int32, Int32, String)

    Devolve lista de documentos associados ao livro definido por parâmetro.

    Declaration
    StdBELista lstDocumentosLivro(string sLivro, int iAno = 0, int iMes = 0, string IDDoc = "")
    Parameters
    Type Name Description
    System.String sLivro
    System.Int32 iAno
    System.Int32 iMes
    System.String IDDoc
    Returns
    Type Description
    StdBELista

    Remove(Int32, String, Int32)

    Remove o documento.

    Declaration
    void Remove(int Ano, string Livro, int NumeroMov)
    Parameters
    Type Name Description
    System.Int32 Ano
    System.String Livro
    System.Int32 NumeroMov

    RemoveID(String)

    Remove o documento.

    Declaration
    void RemoveID(string ID)
    Parameters
    Type Name Description
    System.String ID

    SugereDocumento(Int32, Int32, String)

    Sugere o próximo documento a ser criado.

    Declaration
    CnoBEDocumento SugereDocumento(int iAno, int iMes, string sLivro)
    Parameters
    Type Name Description
    System.Int32 iAno
    System.Int32 iMes
    System.String sLivro
    Returns
    Type Description
    CnoBEDocumento

    ValidaActualizacao(CnoBEDocumento, ref String)

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

    Declaration
    bool ValidaActualizacao(CnoBEDocumento objBE, ref string ErroValidacao)
    Parameters
    Type Name Description
    CnoBEDocumento objBE
    System.String ErroValidacao
    Returns
    Type Description
    System.Boolean

    ValidaRemocao(Int32, String, Int32, ref String)

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

    Declaration
    bool ValidaRemocao(int Ano, string Livro, int NumeroMov, ref string ErroValidacao)
    Parameters
    Type Name Description
    System.Int32 Ano
    System.String Livro
    System.Int32 NumeroMov
    System.String ErroValidacao
    Returns
    Type Description
    System.Boolean

    ValidaRemocaoID(String, ref String)

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

    Declaration
    bool ValidaRemocaoID(string ID, ref string ErroValidacao)
    Parameters
    Type Name Description
    System.String ID
    System.String ErroValidacao
    Returns
    Type Description
    System.Boolean