PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface IRhpBSRecibos

    Classe que disponibiliza regras de negócio e serviços relaccionados com a entidade Recibo.

    Namespace: IRhpBS100
    Assembly: IRhpBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("A49C05F2-49BB-45C2-8422-F81080E76F65")]
    public interface IRhpBSRecibos

    Methods

    Actualiza(RhpBERecibo)

    Actualiza a informação de um recibo.

    Declaration
    void Actualiza(RhpBERecibo objRecibo)
    Parameters
    Type Name Description
    RhpBERecibo objRecibo

    Objecto contendo os valores actuais.

    ActualizaProcessamento(RhpBEReciboProcessamento)

    Actualiza a informação de um processamento associado ao recibo.

    Declaration
    void ActualizaProcessamento(RhpBEReciboProcessamento Processamento)
    Parameters
    Type Name Description
    RhpBEReciboProcessamento Processamento

    Objecto contendo os valores actuais.

    ActualizaValorAtributo(Int32, String, Object)

    Actualiza o valor de um atributo.

    Declaration
    void ActualizaValorAtributo(int ID, string Atributo, object Valor)
    Parameters
    Type Name Description
    System.Int32 ID

    Identificador do recibo.

    System.String Atributo

    Nome do atributo cujo valor será actualizado.

    System.Object Valor

    Novo valor do atributo indicado.

    ActualizaValorAtributoProcessamento(Int32, String, Object)

    Actualiza o valor de um processamento associado ao recibo.

    Declaration
    void ActualizaValorAtributoProcessamento(int NumeroProcessamento, string Atributo, object Valor)
    Parameters
    Type Name Description
    System.Int32 NumeroProcessamento

    Identificador do Nº de processamento.

    System.String Atributo

    Nome do atributo cujo valor será actualizado.

    System.Object Valor

    Novo valor do atributo indicado.

    ActualizaValorAtributos(Int32, StdBECampos)

    Actualiza os valores respectivos de um conjunto de atributos.

    Declaration
    void ActualizaValorAtributos(int ID, StdBECampos Atributos)
    Parameters
    Type Name Description
    System.Int32 ID

    Identificador do recibo.

    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)

    Devolve o valor de um atributo.

    Declaration
    object DaValorAtributo(int ID, string Atributo)
    Parameters
    Type Name Description
    System.Int32 ID

    Identificador do recibo.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributoProcessamento(Int32, String)

    Devolve o valor de um atributo de um processamento associado ao recibo.

    Declaration
    object DaValorAtributoProcessamento(int NumeroProcessamento, string Atributo)
    Parameters
    Type Name Description
    System.Int32 NumeroProcessamento

    Identificador do Nº de processamento.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributos(Int32, String[])

    Devolve o valor de um conjunto de atributos.

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

    Identificador do recibo.

    System.String[] Atributos

    Nome dos atributos cujo valor será actualizado.

    Returns
    Type Description
    StdBECampos

    Edita(Int32)

    Edita a informação de um recibo.

    Declaration
    RhpBERecibo Edita(int ID)
    Parameters
    Type Name Description
    System.Int32 ID

    Identificador do funcionário.

    Returns
    Type Description
    RhpBERecibo

    EditaProcessamento(Int32)

    Edita a informação de um processamento associado ao recibo.

    Declaration
    RhpBEReciboProcessamento EditaProcessamento(int NumeroProcessamento)
    Parameters
    Type Name Description
    System.Int32 NumeroProcessamento

    Identificador do processamento.

    Returns
    Type Description
    RhpBEReciboProcessamento

    Existe(Int32)

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

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

    Identificador do recibo.

    Returns
    Type Description
    System.Boolean

    GuardaReciboComoFicheiroPdf(String, RhpBERecibo)

    Guarda o recibo como ficheiro PDF no ficheiro especificado

    Declaration
    void GuardaReciboComoFicheiroPdf(string strNomeFicheiro, RhpBERecibo objRecibo)
    Parameters
    Type Name Description
    System.String strNomeFicheiro

    Nome do ficheiro

    RhpBERecibo objRecibo

    Identificador do recibos.

    IniciaProcessamentoRecibos()

    Responsável pela inicialização para processamento de recibos

    Declaration
    void IniciaProcessamentoRecibos()

    LeReciboDoFicheiroPdf(String, RhpBERecibo)

    Le o recibo como ficheiro PDF no ficheiro especificado

    Declaration
    void LeReciboDoFicheiroPdf(string strNomeFicheiro, RhpBERecibo objRecibo)
    Parameters
    Type Name Description
    System.String strNomeFicheiro

    Nome do ficheiro

    RhpBERecibo objRecibo

    Identificador do recibos.

    ListarProcessamentos(String, DateTime, DateTime, Int32, ref String, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean)

    Devolve lista dos processamentos para os quais vão ser gerados os recibos

    Declaration
    StdBELista ListarProcessamentos(string strCamposSelect, DateTime datDataInicial, DateTime datDataFinal, int intRecibosAConsiderar, ref string strFiltroRestricoes, bool blnIncluirVencimento, bool blnIncluirExtraordinario, bool blnIncluirSubsFerias, bool blnIncluirSubsNatal, bool blnIncluirEmitidos, bool blnIncluirNaoEmitidos)
    Parameters
    Type Name Description
    System.String strCamposSelect

    Lista dos campos

    System.DateTime datDataInicial

    Data inicial a considerar

    System.DateTime datDataFinal

    Data final a considerar

    System.Int32 intRecibosAConsiderar

    Recibos a considerar: processados, não processados ou todos

    System.String strFiltroRestricoes

    Restrições adicionais

    System.Boolean blnIncluirVencimento

    Incluir vencimento?

    System.Boolean blnIncluirExtraordinario

    Incluir Extraordinários?

    System.Boolean blnIncluirSubsFerias

    Incluir Subs Férias?

    System.Boolean blnIncluirSubsNatal

    Incluir Subs Natal?

    System.Boolean blnIncluirEmitidos

    Incluir emitidos?

    System.Boolean blnIncluirNaoEmitidos

    Incluir não emitidos?

    Returns
    Type Description
    StdBELista

    ProcessaRecibos(RhpBERecibo, Boolean)

    Responsável pelo processamento dos dados a incluir nas tabelas temporárias previamente criadas

    Declaration
    void ProcessaRecibos(RhpBERecibo Recibo, bool TratamentoMultiMoeda)
    Parameters
    Type Name Description
    RhpBERecibo Recibo

    Estrutura com os dados relativos aos recibos a emitir

    System.Boolean TratamentoMultiMoeda

    Tratamento

    Remove(Int32)

    Remove a informação de um recibo.

    Declaration
    void Remove(int ID)
    Parameters
    Type Name Description
    System.Int32 ID

    Identificador do recibo.

    TerminaProcessamentoRecibos()

    Responsável pela limpeza de recursos necessários ao processamento de recibos

    Declaration
    void TerminaProcessamentoRecibos()