PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface IRhpBSFuncionarioRetroactivos

    Classe utilizada para obter as regras de negócio dos movimentos de Retroactivos de um Funcionário.

    Namespace: IRhpBS100
    Assembly: IRhpBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("BDBD41AB-57B3-4506-A4FF-AF65ACF95A71")]
    public interface IRhpBSFuncionarioRetroactivos

    Methods

    Actualiza(RhpBEFuncionarioRetroactivo)

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

    Declaration
    void Actualiza(RhpBEFuncionarioRetroactivo objBEFuncionarioRetroactivo)
    Parameters
    Type Name Description
    RhpBEFuncionarioRetroactivo objBEFuncionarioRetroactivo

    Objecto contendo os valores actuais.

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

    Actualiza o valor de um atributo.

    Declaration
    void ActualizaValorAtributo(int NumCalcRetro, int NumProcessamento, string CodigoRem, 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.String CodigoRem

    Identificador da remuneração.

    System.String Atributo

    Nome do atributo cujo valor será actualizado.

    System.Object Valor

    Novo valor do atributo indicado.

    ActualizaValorAtributos(Int32, Int32, String, StdBECampos)

    Actualiza os valores respectivos de um conjunto de atributos.

    Declaration
    void ActualizaValorAtributos(int NumCalcRetro, int NumProcessamento, string CodigoRem, 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.String CodigoRem

    Identificador da remuneração.

    StdBECampos Atributos

    Objecto contendo os atributos a actualizar e respectivos valores.

    AnulaRetroactivosCalculados(String, Int32, ref String, Int32)

    Permite anular os retroactivos calculados e não processados para determinado funcionário num determinado ano.

    Declaration
    void AnulaRetroactivosCalculados(string strFuncionario, int iAno, ref string strAviso, int iMes = 0)
    Parameters
    Type Name Description
    System.String strFuncionario
    System.Int32 iAno

    Ano dos retroactivos que se pretende anular.

    System.String strAviso

    String utilizada para devolver avisos.

    System.Int32 iMes

    Mês dos retroactivos que se pretende anular.

    AnulaRetroactivosCalculadosNumero(Int32)

    Permite anular os retroactivos calculados e não processados para determinado número de Retroactivo.

    Declaration
    void AnulaRetroactivosCalculadosNumero(int lngNumCalcRetro)
    Parameters
    Type Name Description
    System.Int32 lngNumCalcRetro

    Identificador do numero de cálculo de retroactivo.

    CalculaRetroactivos(RhpBERetroactivos)

    Método utilizado para cálculo de retroactivos

    Declaration
    void CalculaRetroactivos(RhpBERetroactivos colProcsRetro)
    Parameters
    Type Name Description
    RhpBERetroactivos colProcsRetro

    Objecto que contém toda a informação do processamento de retroactivos.

    CarregaRetroactivosJaCalculados(String, Int32, Int32, Int32, Int32)

    Permite carregar os retroactivos já calcuados para um determinado funcionário num determinado ano.

    Declaration
    RhpBERetroactivos CarregaRetroactivosJaCalculados(string sFuncionario, int iAno, int iMesInicial = 0, int iMesFinal = 0, int iTpVenc = 0)
    Parameters
    Type Name Description
    System.String sFuncionario
    System.Int32 iAno

    Ano para o qual se pretende os retroactivos.

    System.Int32 iMesInicial

    Permite limitar a leitura a um determinado período temporal, mês inical.

    System.Int32 iMesFinal

    Permite limitar a leitura a um determinado período temporal, mês final.

    System.Int32 iTpVenc

    permite Carregar apenas retroactivos calculados para determinado tipo de vencimento. 1-Vencimento; 2-Subsídio de férias; 3-Subsídio de Natal.

    Returns
    Type Description
    RhpBERetroactivos

    Devolve um objecto do tipo RHPBERetroactivos com os retroactivos que já existem calculados.

    DaDefCamposUtil()

    Devolve as definições dos campos do utilizador.

    Declaration
    StdBEDefCamposUtil DaDefCamposUtil()
    Returns
    Type Description
    StdBEDefCamposUtil

    DaProximoNumCalculoRetroactivo()

    Permite obter o próximo numerador para o cálculo de retroactivos.

    Declaration
    int DaProximoNumCalculoRetroactivo()
    Returns
    Type Description
    System.Int32

    DaValorAtributo(Int32, Int32, String, String)

    Devolve o valor de um atributo.

    Declaration
    object DaValorAtributo(int NumCalcRetro, int NumProcessamento, string CodigoRem, 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.String CodigoRem

    Identificador da remuneração.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

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

    Devolve o valor de um conjunto de atributos.

    Declaration
    StdBECampos DaValorAtributos(int NumCalcRetro, int NumProcessamento, string CodigoRem, 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.String CodigoRem

    Identificador da remuneração.

    System.String[] Atributos

    Conjunto de atributos dos quais se pretende devolver o valor.

    Returns
    Type Description
    StdBECampos

    DaValorIliquidoAnterior(String, Int32, Int32, Int32, Int32, String)

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

    Declaration
    double DaValorIliquidoAnterior(string Funcionario, int NumProcOriginal, int MesRetroactivo, int IDLinhaOriginal, int Ano, string CodMovimento)
    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 IDLinhaOriginal

    Identificador da linha do processamento original.

    System.Int32 Ano

    Identificador do Ano do processamento original.

    System.String CodMovimento

    Identificador do Movimento do processamento original.

    Returns
    Type Description
    System.Double

    Edita(Int32, Int32, String)

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

    Declaration
    RhpBEFuncionarioRetroactivo Edita(int NumCalcRetro, int NumProcessamento, string CodigoRem)
    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.String CodigoRem

    Identificador da remuneração.

    Returns
    Type Description
    RhpBEFuncionarioRetroactivo

    Existe(Int32, Int32, String)

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

    Declaration
    bool Existe(int NumCalcRetro, int NumProcessamento, string CodigoRem)
    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.String CodigoRem

    Identificador da remuneração.

    Returns
    Type Description
    System.Boolean

    ExistemRetroactivosAno(Int32, String)

    Verifica se existem retroactivos calculado num determinado ano para um determinado funcionário num determinado estado (processados ou não processados).

    Declaration
    bool ExistemRetroactivosAno(int Ano, string Funcionario)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano a que se referem os retroactivos.

    System.String Funcionario

    Funcionário a que se referem os retroactivos.

    Returns
    Type Description
    System.Boolean

    ExistemRetroactivosAno(Int32, String, Int32)

    Verifica se existem retroactivos calculado num determinado ano para um determinado funcionário num determinado estado (processados ou não processados).

    Declaration
    bool ExistemRetroactivosAno(int Ano, string Funcionario, int TipoVencimento)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano a que se referem os retroactivos.

    System.String Funcionario

    Funcionário a que se referem os retroactivos.

    System.Int32 TipoVencimento

    opcional Identificador do tipo de processamento. Não indicar ou indicar o valor -1 significa que se pretende verificar para qualquer tipo de processamento.

    Returns
    Type Description
    System.Boolean

    ExistemRetroactivosAno(Int32, String, Int32, ref Int32)

    Verifica se existem retroactivos calculado num determinado ano para um determinado funcionário num determinado estado (processados ou não processados).

    Declaration
    bool ExistemRetroactivosAno(int Ano, string Funcionario, int TipoVencimento, ref int iEstado)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano a que se referem os retroactivos.

    System.String Funcionario

    Funcionário a que se referem os retroactivos.

    System.Int32 TipoVencimento

    opcional Identificador do tipo de processamento. Não indicar ou indicar o valor -1 significa que se pretende verificar para qualquer tipo de processamento.

    System.Int32 iEstado

    opcional Valor que permite indicar se queremos verificar a existência de retroactivos em determinado estado (já processados ou ainda não processados). -1-qualquer estado; 0-Não processados; 1-Já Processados.

    Returns
    Type Description
    System.Boolean

    ExistemRetroactivosAnoMes(Int32, Int32, String)

    Verifica se existem retroactivos calculado num determinado ano/mês para um determinado funcionário num determinado estado (processados ou não processados).

    Declaration
    bool ExistemRetroactivosAnoMes(int Ano, int Mes, string Funcionario)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano a que se referem os retroactivos.

    System.Int32 Mes

    Mês a que se referem os retroactivos.

    System.String Funcionario

    Funcionário a que se referem os retroactivos.

    Returns
    Type Description
    System.Boolean

    ExistemRetroactivosAnoMes(Int32, Int32, String, Int32)

    Verifica se existem retroactivos calculado num determinado ano/mês para um determinado funcionário num determinado estado (processados ou não processados).

    Declaration
    bool ExistemRetroactivosAnoMes(int Ano, int Mes, string Funcionario, int TipoVencimento)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano a que se referem os retroactivos.

    System.Int32 Mes

    Mês a que se referem os retroactivos.

    System.String Funcionario

    Funcionário a que se referem os retroactivos.

    System.Int32 TipoVencimento

    opcional Identificador do tipo de processamento. Não indicar ou indicar o valor -1 significa que se pretende verificar para qualquer tipo de processamento.

    Returns
    Type Description
    System.Boolean

    ExistemRetroactivosAnoMes(Int32, Int32, String, Int32, ref Int32)

    Verifica se existem retroactivos calculado num determinado ano/mês para um determinado funcionário num determinado estado (processados ou não processados).

    Declaration
    bool ExistemRetroactivosAnoMes(int Ano, int Mes, string Funcionario, int TipoVencimento, ref int iEstado)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano a que se referem os retroactivos.

    System.Int32 Mes

    Mês a que se referem os retroactivos.

    System.String Funcionario

    Funcionário a que se referem os retroactivos.

    System.Int32 TipoVencimento

    opcional Identificador do tipo de processamento. Não indicar ou indicar o valor -1 significa que se pretende verificar para qualquer tipo de processamento.

    System.Int32 iEstado

    opcional Valor que permite indicar se queremos verificar a existência de retroactivos em determinado estado (já processados ou ainda não processados). -1-qualquer estado; 0-Não processados; 1-Já Processados.

    Returns
    Type Description
    System.Boolean

    ExistemRetroCalculadosAno(Int32, String, Int32)

    Verifica se existem retroactivos calculado num determinado ano para um determinado funcionário.

    Declaration
    bool ExistemRetroCalculadosAno(int Ano, string Funcionario, int TipoVencimento = -1)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano a que se referem os retroactivos.

    System.String Funcionario

    Funcionário a que se referem os retroactivos.

    System.Int32 TipoVencimento

    opcional Identificador do tipo de processamento. Não indicar ou indicar o valor -1 significa que se pretende verificar para qualquer tipo de processamento.

    Returns
    Type Description
    System.Boolean

    ExistemRetroCalculadosAnoMes(Int32, Int32, String, Int32)

    Verifica se existem retroactivos calculado num determinado ano/mês para um determinado funcionário.

    Declaration
    bool ExistemRetroCalculadosAnoMes(int Ano, int Mes, string Funcionario, int TipoVencimento = -1)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano a que se referem os retroactivos.

    System.Int32 Mes

    MÊs a que se referem os retroactivos.

    System.String Funcionario

    Funcionário a que se referem os retroactivos.

    System.Int32 TipoVencimento

    opcional Identificador do tipo de processamento. Não indicar ou indicar o valor -1 significa que se pretende verificar para qualquer tipo de processamento.

    Returns
    Type Description
    System.Boolean

    GravaRetroactivos(RhpBERetroactivos)

    Grava a informação de retroactivos previamente calculada

    Declaration
    void GravaRetroactivos(RhpBERetroactivos colProcsRetro)
    Parameters
    Type Name Description
    RhpBERetroactivos colProcsRetro

    Objecto que contém toda a informação sobre os retroactivos a gravar.

    LstFuncionarioRetroactivos()

    Devolve uma listagem de retroactivos.

    Declaration
    StdBELista LstFuncionarioRetroactivos()
    Returns
    Type Description
    StdBELista

    Remove(Int32, Int32, String)

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

    Declaration
    void Remove(int NumCalcRetro, int NumProcessamento, string CodigoRem)
    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.String CodigoRem

    Identificador da remuneração.

    ValidaActualizacao(RhpBEFuncionarioRetroactivo, ref String)

    Valida a actualização.

    Declaration
    bool ValidaActualizacao(RhpBEFuncionarioRetroactivo ObjFuncionarioRetroactivo, ref string ErroValidacao)
    Parameters
    Type Name Description
    RhpBEFuncionarioRetroactivo ObjFuncionarioRetroactivo

    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, 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, string CodigoRem, 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.String CodigoRem

    Identificador da remuneração.

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detectados.

    Returns
    Type Description
    System.Boolean