Interface IRhpBSFundosPensao

Classe utilizada para obter as regras de negócio dos Fundos de Pensão.

Namespace: IRhpBS100

Assembly: IRhpBS100.dll

Syntax

[ComVisible(true)]
[Guid("936B81F3-DDC7-4D60-9907-9E5739A1B423")]
public interface IRhpBSFundosPensao

Methods

Actualiza(RhpBEFundoPensao)

Actualiza a informação de um fundo de pensão.

Declaration

void Actualiza(RhpBEFundoPensao objBEFundoPensao)

Parameters

Type	Name	Description
RhpBEFundoPensao	objBEFundoPensao	Objecto contendo os valores actuais.

Actualiza(RhpBEFundoPensao, ref String)

Actualiza a informação de um fundo de pensão.

Declaration

void Actualiza(RhpBEFundoPensao objBEFundoPensao, ref string strAviso)

Parameters

Type	Name	Description
RhpBEFundoPensao	objBEFundoPensao	Objecto contendo os valores actuais.
System.String	strAviso	Recebe a descrição de eventuais avisos.

ActualizaValorAtributo(String, String, Object)

Actualiza o valor de um atributo.

Declaration

void ActualizaValorAtributo(string Fundo, string Atributo, object Valor)

Parameters

Type	Name	Description
System.String	Fundo	Identificador do fundo de pensão.
System.String	Atributo	Nome do atributo cujo valor será actualizado.
System.Object	Valor	Novo valor do atributo indicado.

ActualizaValorAtributos(String, StdBECampos)

Actualiza os valores respectivos de um conjunto de atributos.

Declaration

void ActualizaValorAtributos(string Fundo, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	Fundo	Identificador do fundo de pensão.
StdBECampos	Atributos	Objecto contendo os atributos a actualizar e respectivos valores.

AnularCessacao(String, String, out String, CancelEventHandler)

Anular registo de fim de vínculo incorrectamente comunicado.

Declaration

RhpBETipos.CodigoErroServicoEnum AnularCessacao(string PasswordSvc, string Funcionario, out string Mensagem, CancelEventHandler CancelEvt = null)

Parameters

Type	Name	Description
System.String	PasswordSvc	Password de acesso ao serviço
System.String	Funcionario	Identificador funcionário para efetuar a comunicação
System.String	Mensagem	Mensagem de erro ou aviso gerado pelo serviço
System.ComponentModel.CancelEventHandler	CancelEvt	Handler para evento de confirmação com informação de dados comunicados. O parâmetro sender contém uma string com a informação a remeter.

Returns

Type	Description
RhpBETipos.CodigoErroServicoEnum	Verdadeiro em sucesso

AnularUltimaAtualizacaoVencimento(String, String, out String, CancelEventHandler)

Anula a última atualização de vencimento efetuada incorretamente registada.

Declaration

RhpBETipos.CodigoErroServicoEnum AnularUltimaAtualizacaoVencimento(string PasswordSvc, string Funcionario, out string Mensagem, CancelEventHandler CancelEvt = null)

Parameters

Type	Name	Description
System.String	PasswordSvc	Password de acesso ao serviço
System.String	Funcionario	Identificador funcionário para efetuar a comunicação
System.String	Mensagem	Mensagem de erro ou aviso gerado pelo serviço
System.ComponentModel.CancelEventHandler	CancelEvt	Handler para evento de confirmação com informação de dados comunicados. O parâmetro sender contém uma string com a informação a remeter.

Returns

Type	Description
RhpBETipos.CodigoErroServicoEnum	Verdadeiro em sucesso

AtualizarVencimento(String, String, out String, CancelEventHandler)

Regista uma atualização de vencimento.

Declaration

RhpBETipos.CodigoErroServicoEnum AtualizarVencimento(string PasswordSvc, string Funcionario, out string Mensagem, CancelEventHandler CancelEvt = null)

Parameters

Type	Name	Description
System.String	PasswordSvc	Password de acesso ao serviço
System.String	Funcionario	Identificador funcionário para efetuar a comunicação
System.String	Mensagem	Mensagem de erro ou aviso gerado pelo serviço
System.ComponentModel.CancelEventHandler	CancelEvt	Handler para evento de confirmação com informação de dados comunicados. O parâmetro sender contém uma string com a informação a remeter.

Returns

Type	Description
RhpBETipos.CodigoErroServicoEnum	Verdadeiro em sucesso

DaDefCamposUtil()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

Type	Description
StdBEDefCamposUtil

DaDescontos(String, ref Double, ref Double)

Determina os descontos relativos aos Fundos de Pensão.

Declaration

bool DaDescontos(string FundoPensao, ref double DescontoEmpresa, ref double DescontoEmpregado)

Parameters

Type	Name	Description
System.String	FundoPensao	Identificador de Fundo de Pensão.
System.Double	DescontoEmpresa	Valor do Desconto da Empresa.
System.Double	DescontoEmpregado	Valor do Desconto do Empregado.

Returns

Type	Description
System.Boolean

DaDescontosHistorico(String, DateTime, out Double, out Double)

Devolve por referência, os Descontos de um Fundo de Pensao que vigoram numa determinada Data.

Declaration

bool DaDescontosHistorico(string FundoPensao, DateTime Data, out double DescontoEmpresa, out double DescontoEmpregado)

Parameters

Type	Name	Description
System.String	FundoPensao	Identificador da instituição de Fundos Pensão.
System.DateTime	Data	a procurar o desconto. Pode ser uma data anterior, actual ou superior
System.Double	DescontoEmpresa	Variável que será preenchida com o valor de desconto da entidade patronal.
System.Double	DescontoEmpregado	Variável que será preenchida com o valor de desconto do empregado.

Returns

Type	Description
System.Boolean

DaFundoDesconto(String)

Determina o Fundo de Pensão relativo a determinado desconto.

Declaration

string DaFundoDesconto(string Desconto)

Parameters

Type	Name	Description
System.String	Desconto	identificador do Desconto.

Returns

Type	Description
System.String

DaFundoDescontoRetroactivo(String)

Devolve o código do Fundo de Pensão relativo ao desconto do retroactivo.

Declaration

string DaFundoDescontoRetroactivo(string DescontoRetroactivo)

Parameters

Type	Name	Description
System.String	DescontoRetroactivo	identificador do Desconto de Retroactivos.

Returns

Type	Description
System.String

DaUltimaDataAplicacao(String)

Devolve a data que vigora (última) de um Fundo Pensão .

Declaration

DateTime DaUltimaDataAplicacao(string FundoPensao)

Parameters

Type	Name	Description
System.String	FundoPensao

Returns

Type	Description
System.DateTime

DaValorAtributo(String, String)

Devolve o valor de um atributo.

Declaration

object DaValorAtributo(string Fundo, string Atributo)

Parameters

Type	Name	Description
System.String	Fundo	Identificador do fundo de pensão.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

Type	Description
System.Object

DaValorAtributoLock(String, String)

Devolve o valor de um atributo, respeitando os locks da base de dados.

Declaration

object DaValorAtributoLock(string Fundo, string Atributo)

Parameters

Type	Name	Description
System.String	Fundo	Identificador do fundo de pensão.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

Type	Description
System.Object

DaValorAtributos(String, String[])

Devolve o valor de um conjunto de atributos.

Declaration

StdBECampos DaValorAtributos(string Fundo, params string[] Atributos)

Parameters

Type	Name	Description
System.String	Fundo	Identificador do fundo de pensão.
System.String[]	Atributos	Conjunto de atributos dos quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosLock(String, String[])

Devolve o valor de um conjunto de atributos, respeitando os locks da base de dados.

Declaration

StdBECampos DaValorAtributosLock(string Fundo, params string[] Atributos)

Parameters

Type	Name	Description
System.String	Fundo	Identificador do fundo de pensão.
System.String[]	Atributos	Conjunto de atributos dos quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

Edita(String)

Edita a informação de um fundo de pensão.

Declaration

RhpBEFundoPensao Edita(string Fundo)

Parameters

Type	Name	Description
System.String	Fundo	Identificador do fundo de pensão.

Returns

Type	Description
RhpBEFundoPensao

Existe(String)

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

Declaration

bool Existe(string Fundo)

Parameters

Type	Name	Description
System.String	Fundo	Identificador do fundo de pensão.

Returns

Type	Description
System.Boolean

ExisteDesconto(String)

Devolve a indicação da existência de descontos relativos ao Fundo de Pensão.

Declaration

bool ExisteDesconto(string Desconto)

Parameters

Type	Name	Description
System.String	Desconto

Returns

Type	Description
System.Boolean

ExisteDescontoFundo(String, String)

Devolve a indicação da existência do desconto relativos ao Fundo de Pensão.

Declaration

bool ExisteDescontoFundo(string Fundo, string Desconto)

Parameters

Type	Name	Description
System.String	Fundo
System.String	Desconto

Returns

Type	Description
System.Boolean

ExisteDescontoRetroactivos(String)

Devolve a indicação da existência de descontos de retroactivos relativos ao Fundo de Pensão.

Declaration

bool ExisteDescontoRetroactivos(string Desconto)

Parameters

Type	Name	Description
System.String	Desconto

Returns

Type	Description
System.Boolean

RegistarCessacao(String, String, out String, CancelEventHandler)

Registar o fim do vínculo.

Declaration

RhpBETipos.CodigoErroServicoEnum RegistarCessacao(string PasswordSvc, string Funcionario, out string Mensagem, CancelEventHandler CancelEvt = null)

Parameters

Type	Name	Description
System.String	PasswordSvc	Password de acesso ao serviço
System.String	Funcionario	Identificador funcionário para efetuar a comunicação
System.String	Mensagem	Mensagem de erro ou aviso gerado pelo serviço
System.ComponentModel.CancelEventHandler	CancelEvt	Handler para evento de confirmação com informação de dados comunicados. O parâmetro sender contém uma string com a informação a remeter.

Returns

Type	Description
RhpBETipos.CodigoErroServicoEnum	Verdadeiro em sucesso

RegistarVinculo(String, String, out String, Boolean, CancelEventHandler)

Regista o vínculo do funcionário nos fundos

Declaration

RhpBETipos.CodigoErroServicoEnum RegistarVinculo(string PasswordSvc, string Funcionario, out string Mensagem, bool ComunicaDataFimContrato = true, CancelEventHandler CancelEvt = null)

Parameters

Type	Name	Description
System.String	PasswordSvc	Password de acesso ao serviço
System.String	Funcionario	Funcionário
System.String	Mensagem	Mensagem de erro ou aviso gerado pelo serviço
System.Boolean	ComunicaDataFimContrato	Indica se deve ser comunicada data de fim de contrato para contratos a termo
System.ComponentModel.CancelEventHandler	CancelEvt	Handler para evento de confirmação com informação de dados comunicados. O parâmetro sender contém uma string com a informação a remeter.

Returns

Type	Description
RhpBETipos.CodigoErroServicoEnum	Verdadeiro em sucesso

Remove(String)

Remove a informação de um fundo de pensão.

Declaration

void Remove(string Fundo)

Parameters

Type	Name	Description
System.String	Fundo	Identificador do fundo de pensão.

ValidaActualizacao(RhpBEFundoPensao, ref String, String)

Efectua a validação dos dados de fundos de pensão.

Declaration

bool ValidaActualizacao(RhpBEFundoPensao ObjFundoPensao, ref string ErroValidacao, string AvisoValidacao)

Parameters

Type	Name	Description
RhpBEFundoPensao	ObjFundoPensao	Objecto contendo os novos valores a actualizar.
System.String	ErroValidacao	Recebe a descrição de eventuais erros detectados.
System.String	AvisoValidacao	Recebe a descrição de eventuais avisos.

Returns

Type	Description
System.Boolean

ValidaRemocao(String, ref String)

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

Declaration

bool ValidaRemocao(string Fundo, ref string ErroValidacao)

Parameters

Type	Name	Description
System.String	Fundo	Identificador do fundo de pensão.
System.String	ErroValidacao	Recebe a descrição de eventuais erros detectados.

Returns

Type	Description
System.Boolean