PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface IRhpBSMovimentosRetroactivos

    Classe utilizada para obter as regras de negócio dos registos de Movimentos de Retroactivos.

    Namespace: IRhpBS100
    Assembly: IRhpBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("2E0F367F-EA4C-4BF5-9630-BC866453FC81")]
    public interface IRhpBSMovimentosRetroactivos

    Methods

    Actualiza(RhpBEMovimentoRetroactivo)

    Actualiza a informação de um registo de movimentos de retroactivos.

    Declaration
    void Actualiza(RhpBEMovimentoRetroactivo objBEMovimentoRetroactivo)
    Parameters
    Type Name Description
    RhpBEMovimentoRetroactivo objBEMovimentoRetroactivo

    Objecto contendo os valores actuais.

    ActualizarRetroactivosProcessados(String, Int32, Int32, Int32)

    Efectua a actualização dos retroactivos processados.

    Declaration
    void ActualizarRetroactivosProcessados(string Funcionario, int NumPeriodo, int Ano, int NumProcProcessado)
    Parameters
    Type Name Description
    System.String Funcionario

    Identificador do funcionário.

    System.Int32 NumPeriodo

    Período dos retroactivos

    System.Int32 Ano

    Ano dos retroactivos

    System.Int32 NumProcProcessado

    Identificador do processamento onde o cálculo de Retroactivo foi lançado

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

    Actualiza o valor de um atributo.

    Declaration
    void ActualizaValorAtributo(int NumCalcRetro, int NumProcessamento, byte TipoTabela, string Movimento, string Atributo, object Valor)
    Parameters
    Type Name Description
    System.Int32 NumCalcRetro

    Número de cálculo de retroactivo.

    System.Int32 NumProcessamento

    Número de Processamento a que se refere os retroactivos.

    System.Byte TipoTabela

    Identificador do tipo de tabela (remuneração, desconto ou hora extra).

    System.String Movimento

    Identificador da remuneração, desconto ou hora extra.

    System.String Atributo

    Nome do atributo cujo valor será actualizado.

    System.Object Valor

    Novo valor do atributo indicado.

    ActualizaValorAtributos(Int32, Int32, Byte, String, StdBECampos)

    Actualiza os valores respectivos de um conjunto de atributos.

    Declaration
    void ActualizaValorAtributos(int NumCalcRetro, int NumProcessamento, byte TipoTabela, string Movimento, StdBECampos Atributos)
    Parameters
    Type Name Description
    System.Int32 NumCalcRetro

    Número de cálculo de retroactivo.

    System.Int32 NumProcessamento

    Número de Processamento a que se refere os retroactivos.

    System.Byte TipoTabela

    Identificador do tipo de tabela (remuneração, desconto ou hora extra).

    System.String Movimento

    Identificador da remuneração, desconto ou hora extra.

    StdBECampos Atributos

    Objecto contendo os atributos a actualizar e respectivos valores.

    AnulaRetroactivosProcessamento(String, Int32, Int32, Int32, Int32)

    Anula os retroactivos calculados para um determinado processamento. O processamento é identificado pelo ano, número do período e tipo de vencimento.

    Declaration
    void AnulaRetroactivosProcessamento(string strFuncionario, int iAno, int iNumPeriodo, int iTipoVencimento, int lngNumCalcRetro = 0)
    Parameters
    Type Name Description
    System.String strFuncionario

    Identificador do funcionário.

    System.Int32 iAno

    Ano do retroactivo que se pretende anular.

    System.Int32 iNumPeriodo

    Número do tipo período do processamento relativo ao retroactivo que se pretende anular.

    System.Int32 iTipoVencimento

    Identificador do tipo de vencimento do processamento relativo ao retroactivo que se pretende anular, 1-Vencimento; 2-Subsídio de férias; 3-Subsídio de Natal.

    System.Int32 lngNumCalcRetro

    Identificador do numero de cálculo de retroactivo.

    AnularRetroactivosProcessados(String, Int32, Int32, Int32)

    Efectua a anulação dos retroactivos processados.

    Declaration
    void AnularRetroactivosProcessados(string Funcionario, int NumPeriodo, int Ano, int NumProcProcessado)
    Parameters
    Type Name Description
    System.String Funcionario

    Identificador do funcionário.

    System.Int32 NumPeriodo

    Período dos retroactivos

    System.Int32 Ano

    Ano dos retroactivos

    System.Int32 NumProcProcessado

    Identificador do processamento onde o cálculo de Retroactivo foi lançado

    DaDefCamposUtil()

    Devolve as definições dos campos do utilizador.

    Declaration
    StdBEDefCamposUtil DaDefCamposUtil()
    Returns
    Type Description
    StdBEDefCamposUtil

    DaTotalRetroactivosCalculados(String, String, Int32, Int32, Boolean, Int32)

    Devolve o total dos retroactivos calculados num intervalo de períodos

    Declaration
    double DaTotalRetroactivosCalculados(string Funcionario, string codRetro, int MinPeriodo, int MaxPeriodo, bool blnProcessado, int AnoProc)
    Parameters
    Type Name Description
    System.String Funcionario

    Identificador do funcionário.

    System.String codRetro

    Código de movimento de retroactivos

    System.Int32 MinPeriodo

    Limite inferior do intervalo de períodos a calcular

    System.Int32 MaxPeriodo
    System.Boolean blnProcessado

    Indicação de retroactivos já calculados ou não

    System.Int32 AnoProc

    Ano dos retroactivos a calcular

    Returns
    Type Description
    System.Double

    DaValorAtributo(Int32, Int32, Byte, String, String)

    Devolve o valor de um atributo.

    Declaration
    object DaValorAtributo(int NumCalcRetro, int NumProcessamento, byte TipoTabela, string Movimento, string Atributo)
    Parameters
    Type Name Description
    System.Int32 NumCalcRetro

    Número de cálculo de retroactivo.

    System.Int32 NumProcessamento

    Número de Processamento a que se refere os retroactivos.

    System.Byte TipoTabela

    Identificador do tipo de tabela (remuneração, desconto ou hora extra).

    System.String Movimento

    Identificador da remuneração, desconto ou hora extra.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

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

    Devolve o valor de um conjunto de atributos.

    Declaration
    StdBECampos DaValorAtributos(int NumCalcRetro, int NumProcessamento, byte TipoTabela, string Movimento, params string[] Atributos)
    Parameters
    Type Name Description
    System.Int32 NumCalcRetro

    Número de cálculo de retroactivo.

    System.Int32 NumProcessamento

    Número de Processamento a que se refere os retroactivos.

    System.Byte TipoTabela

    Identificador do tipo de tabela (remuneração, desconto ou hora extra).

    System.String Movimento

    Identificador da remuneração, desconto ou hora extra.

    System.String[] Atributos

    Conjunto de atributos dos quais se pretende devolver o valor.

    Returns
    Type Description
    StdBECampos

    DaValorLiquidoMovimento(Int32, Int32)

    Devolve o valor Liquido de uma linha de um processamento.

    Declaration
    double DaValorLiquidoMovimento(int NumProcOriginal, int IDLinhaOriginal)
    Parameters
    Type Name Description
    System.Int32 NumProcOriginal

    Identificador do número de processamento original.

    System.Int32 IDLinhaOriginal

    Identificador da linha do processamento original.

    Returns
    Type Description
    System.Double

    DaValorLiquidoRetroactivoCalculado(String, Int32, Int32, Int32, String, Int32)

    Devolve o valor Liquido do último calculo de retroactivos efectuado.

    Declaration
    double DaValorLiquidoRetroactivoCalculado(string Funcionario, int NumProcOriginal, int MesRetroactivo, int Ano, string CodMovimento, int TipoTabela)
    Parameters
    Type Name Description
    System.String Funcionario

    Identificador do funcionário.

    System.Int32 NumProcOriginal

    Identificador do número de processamento original.

    System.Int32 MesRetroactivo

    Identificador do Mes do processamento original.

    System.Int32 Ano

    Identificador do Ano do processamento original.

    System.String CodMovimento

    Identificador do Movimento do processamento original.

    System.Int32 TipoTabela

    Identificador do Tipo da Linha a seleccionar.

    Returns
    Type Description
    System.Double

    Edita(Int32, Int32, Byte, String)

    Edita a informação de um registo de movimentos de retroactivos.

    Declaration
    RhpBEMovimentoRetroactivo Edita(int NumCalcRetro, int NumProcessamento, byte TipoTabela, string Movimento)
    Parameters
    Type Name Description
    System.Int32 NumCalcRetro

    Número de cálculo de retroactivo.

    System.Int32 NumProcessamento

    Número de Processamento a que se refere os retroactivos.

    System.Byte TipoTabela

    Identificador do tipo de tabela (remuneração, desconto ou hora extra).

    System.String Movimento

    Identificador da remuneração, desconto ou hora extra.

    Returns
    Type Description
    RhpBEMovimentoRetroactivo

    Existe(Int32, Int32, Byte, String)

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

    Declaration
    bool Existe(int NumCalcRetro, int NumProcessamento, byte TipoTabela, string Movimento)
    Parameters
    Type Name Description
    System.Int32 NumCalcRetro

    Número de cálculo de retroactivo.

    System.Int32 NumProcessamento

    Número de Processamento a que se refere os retroactivos.

    System.Byte TipoTabela

    Identificador do tipo de tabela (remuneração, desconto ou hora extra).

    System.String Movimento

    Identificador da remuneração, desconto ou hora extra.

    Returns
    Type Description
    System.Boolean

    LstMovimentosRetroactivos()

    Devolve uma listagem de movimentos de retroactivos.

    Declaration
    StdBELista LstMovimentosRetroactivos()
    Returns
    Type Description
    StdBELista

    LstProcessamentosRecalculados(String, Int32)

    Devolve uma lista de processamentos para os quais existem retroactivos calculados.

    Declaration
    StdBELista LstProcessamentosRecalculados(string strFuncionario, int iAno)
    Parameters
    Type Name Description
    System.String strFuncionario

    Identificador do funcionário.

    System.Int32 iAno

    Ano dos processamentos que se pretende listar.

    Returns
    Type Description
    StdBELista

    LstProcessamentosRecalculados(String, Int32, Int32)

    Devolve uma lista de processamentos para os quais existem retroactivos calculados.

    Declaration
    StdBELista LstProcessamentosRecalculados(string strFuncionario, int iAno, int iMes)
    Parameters
    Type Name Description
    System.String strFuncionario

    Identificador do funcionário.

    System.Int32 iAno

    Ano dos processamentos que se pretende listar.

    System.Int32 iMes

    Mes dos processamentos que se pretende listar.

    Returns
    Type Description
    StdBELista

    LstProcessamentosRecalculados(String, Int32, Int32, Int32)

    Devolve uma lista de processamentos para os quais existem retroactivos calculados.

    Declaration
    StdBELista LstProcessamentosRecalculados(string strFuncionario, int iAno, int iMes, int iTipoVencimento)
    Parameters
    Type Name Description
    System.String strFuncionario

    Identificador do funcionário.

    System.Int32 iAno

    Ano dos processamentos que se pretende listar.

    System.Int32 iMes

    Mes dos processamentos que se pretende listar.

    System.Int32 iTipoVencimento

    Identificador do tipo de vencimento, opcional (1-Vencimento; 2-Subsídio de férias; 3-Subsídio de Natal).

    Returns
    Type Description
    StdBELista

    LstProcessamentosRecalculados(String, Int32, Int32, Int32, ref Int32)

    Devolve uma lista de processamentos para os quais existem retroactivos calculados.

    Declaration
    StdBELista LstProcessamentosRecalculados(string strFuncionario, int iAno, int iMes, int iTipoVencimento, ref int iEstado)
    Parameters
    Type Name Description
    System.String strFuncionario

    Identificador do funcionário.

    System.Int32 iAno

    Ano dos processamentos que se pretende listar.

    System.Int32 iMes

    Mes dos processamentos que se pretende listar.

    System.Int32 iTipoVencimento

    Identificador do tipo de vencimento, opcional (1-Vencimento; 2-Subsídio de férias; 3-Subsídio de Natal).

    System.Int32 iEstado

    Estado dos retroactivos, opcional(-1-Qualquer estado; 0-Não processados; 1-Já processados).

    Returns
    Type Description
    StdBELista

    LstRetroactivosCalculados(String, String, Int32, Int32, Boolean, Int32)

    Devolve uma lista de retroactivos calculados num intervalo de períodos

    Declaration
    StdBELista LstRetroactivosCalculados(string Funcionario, string codRetro, int MinPeriodo, int MaxPeriodo, bool blnProcessado, int AnoProc)
    Parameters
    Type Name Description
    System.String Funcionario

    Identificador do funcionário.

    System.String codRetro

    Código de movimento de retroactivos

    System.Int32 MinPeriodo

    Limite inferior do intervalo de períodos

    System.Int32 MaxPeriodo
    System.Boolean blnProcessado

    Indicação de retroactivos já calculados ou não

    System.Int32 AnoProc

    Ano dos retroactivos

    Returns
    Type Description
    StdBELista

    LstRetroactivosDeDescontos(String, Int32, String, Int32)

    Devolve uma listagem de retroactivos de descontos.

    Declaration
    StdBELista LstRetroactivosDeDescontos(string Funcionario, int NumPeriodo, string Periodo, int Ano)
    Parameters
    Type Name Description
    System.String Funcionario

    Identificador do funcionário.

    System.Int32 NumPeriodo

    Número do período pretendido.

    System.String Periodo

    Tipo de período.

    System.Int32 Ano

    Ano a que se referem os retroactivos.

    Returns
    Type Description
    StdBELista

    LstRetroactivosDeRemuneracoes(String, Int32, String, Int32)

    Devolve uma listagem de retroactivos de remunerações.

    Declaration
    StdBELista LstRetroactivosDeRemuneracoes(string Funcionario, int NumPeriodo, string Periodo, int Ano)
    Parameters
    Type Name Description
    System.String Funcionario

    Identificador do funcionário.

    System.Int32 NumPeriodo

    Número do período pretendido.

    System.String Periodo

    Tipo de período.

    System.Int32 Ano

    Ano a que se referem os retroactivos.

    Returns
    Type Description
    StdBELista

    Remove(Int32, Int32, Byte, String)

    Remove a informação de um registo de movimentos de retroactivos.

    Declaration
    void Remove(int NumCalcRetro, int NumProcessamento, byte TipoTabela, string Movimento)
    Parameters
    Type Name Description
    System.Int32 NumCalcRetro

    Número de cálculo de retroactivo.

    System.Int32 NumProcessamento

    Número de Processamento a que se refere os retroactivos.

    System.Byte TipoTabela

    Identificador do tipo de tabela (remuneração, desconto ou hora extra).

    System.String Movimento

    Identificador da remuneração, desconto ou hora extra.

    ValidaActualizacao(RhpBEMovimentoRetroactivo, ref String)

    Efectua a validação dos dados de movimentos de retroactivos.

    Declaration
    bool ValidaActualizacao(RhpBEMovimentoRetroactivo ObjMovimentoRetroactivo, ref string ErroValidacao)
    Parameters
    Type Name Description
    RhpBEMovimentoRetroactivo ObjMovimentoRetroactivo

    Objecto contendo os novos valores a actualizar.

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detectados.

    Returns
    Type Description
    System.Boolean

    ValidaRemocao(Int32, Int32, Byte, String, ref String)

    Efectua a validação de um registo antes de ser efectuada a sua remoção.

    Declaration
    bool ValidaRemocao(int NumCalcRetro, int NumProcessamento, byte TipoTabela, string Movimento, ref string ErroValidacao)
    Parameters
    Type Name Description
    System.Int32 NumCalcRetro

    Número de cálculo de retroactivo.

    System.Int32 NumProcessamento

    Número de Processamento a que se refere os retroactivos.

    System.Byte TipoTabela

    Identificador do tipo de tabela (remuneração, desconto ou hora extra).

    System.String Movimento

    Identificador da remuneração, desconto ou hora extra.

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detectados.

    Returns
    Type Description
    System.Boolean