Interface IRhpBSInstituicaoHistorico

IRhpBSInstituicaoHistorico - Classe utilizada para obter as regras de negócio do historico de descontos das instituicões.

Namespace: IRhpBS100

Assembly: IRhpBS100.dll

Syntax

[ComVisible(true)]
[Guid("7AD43009-0EB5-4203-B3AD-0E4E48B99E54")]
public interface IRhpBSInstituicaoHistorico

Methods

Actualiza(RhpBEInstituicaoHistorico)

Actualiza a informação do desconto de uma instituição numa determinada data.

Declaration

void Actualiza(RhpBEInstituicaoHistorico objInstituicaoHistorico)

Parameters

Type	Name	Description
RhpBEInstituicaoHistorico	objInstituicaoHistorico	Objecto com dados actuais de descontos de uma instituição

ActualizaInstituicaoHistoricos(RhpBEInstituicaoHistoricos)

Método que permite criar/actualizar uma colecção de BEInstituicaoHistorico

Declaration

void ActualizaInstituicaoHistoricos(RhpBEInstituicaoHistoricos objInstituicaoHistoricos)

Parameters

Type	Name	Description
RhpBEInstituicaoHistoricos	objInstituicaoHistoricos	Objecto com colecção de descontos de uma instituição

ActualizaInstituicaoHistoricos(RhpBEInstituicaoHistoricos, ref String)

Método que permite criar/actualizar uma colecção de BEInstituicaoHistorico

Declaration

void ActualizaInstituicaoHistoricos(RhpBEInstituicaoHistoricos objInstituicaoHistoricos, ref string strAviso)

Parameters

Type	Name	Description
RhpBEInstituicaoHistoricos	objInstituicaoHistoricos	Objecto com colecção de descontos de uma instituição
System.String	strAviso	Retorna eventuais avisos

ActualizaValorAtributo(String, String, String)

Actualiza o valor de um atributo.

Declaration

void ActualizaValorAtributo(string ID, string Atributo, string Valor)

Parameters

Type	Name	Description
System.String	ID	Identificador (ID) do registo de desconto de uma instituição.
System.String	Atributo	Nome do atributo cujo valor será actualizado.
System.String	Valor	Valor do atributo que será actualizado.

ActualizaValorAtributos(String, StdBECampos)

Actualiza os valores respectivos de um conjunto de atributos.

Declaration

void ActualizaValorAtributos(string ID, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	ID	Identificador de um desconto de apólice.
StdBECampos	Atributos	Identifica os atributos e os respectivos valores a actualizar.

DaDefCamposUtil()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

Type	Description
StdBEDefCamposUtil

DaDescontosHistorico(String, RhpBEInstituicaoHistorico.EnumTipoInstituicao, DateTime, out Double, out Double, out Boolean)

Devolve os Descontos de uma Entidade em vigor numa determinada Data.

Declaration

bool DaDescontosHistorico(string Entidade, RhpBEInstituicaoHistorico.EnumTipoInstituicao Instituicao, DateTime Data, out double DescontoEmpresa, out double DescontoEmpregado, out bool Percentual)

Parameters

Type	Name	Description
System.String	Entidade	Identificador da instituição a pesqisar.
RhpBEInstituicaoHistorico.EnumTipoInstituicao	Instituicao	parametro para identificação da instituiçã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.
System.Boolean	Percentual	Variável que será preenchida com o valor TRUE se os descontos apresentados estão em percentagem.

Returns

Type	Description
System.Boolean

DaDescontosHistorico(String, RhpBEInstituicaoHistorico.EnumTipoInstituicao, DateTime, out Double, out Double, out Boolean, out String)

Devolve os Descontos de uma Entidade em vigor numa determinada Data.

Declaration

bool DaDescontosHistorico(string Entidade, RhpBEInstituicaoHistorico.EnumTipoInstituicao Instituicao, DateTime Data, out double DescontoEmpresa, out double DescontoEmpregado, out bool Percentual, out string Moeda)

Parameters

Type	Name	Description
System.String	Entidade	Identificador da instituição a pesqisar.
RhpBEInstituicaoHistorico.EnumTipoInstituicao	Instituicao	parametro para identificação da instituiçã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.
System.Boolean	Percentual	Variável que será preenchida com o valor TRUE se os descontos apresentados estão em percentagem.
System.String	Moeda	parametro opcional para retorno da moeda do desconto, no caso das intituições do tipo Sindicato.

Returns

Type	Description
System.Boolean

DaDescontosHistorico(String, RhpBEInstituicaoHistorico.EnumTipoInstituicao, DateTime, out Double, out Double, out Boolean, out String, out RhpBETipos.EnuTipoValorMinimo)

Devolve os Descontos de uma Entidade em vigor numa determinada Data.

Declaration

bool DaDescontosHistorico(string Entidade, RhpBEInstituicaoHistorico.EnumTipoInstituicao Instituicao, DateTime Data, out double DescontoEmpresa, out double DescontoEmpregado, out bool Percentual, out string Moeda, out RhpBETipos.EnuTipoValorMinimo TipoValorMinimo)

Parameters

Type	Name	Description
System.String	Entidade	Identificador da instituição a pesqisar.
RhpBEInstituicaoHistorico.EnumTipoInstituicao	Instituicao	parametro para identificação da instituiçã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.
System.Boolean	Percentual	Variável que será preenchida com o valor TRUE se os descontos apresentados estão em percentagem.
System.String	Moeda	parametro opcional para retorno da moeda do desconto, no caso das intituições do tipo Sindicato.
RhpBETipos.EnuTipoValorMinimo	TipoValorMinimo	parametro para retorno do tipo do valor minimo indicado.

Returns

Type	Description
System.Boolean

DaUltimaDataAplicacao(String, RhpBEInstituicaoHistorico.EnumTipoInstituicao)

Devolve a data que vigora (última) de uma entidade.

Declaration

DateTime DaUltimaDataAplicacao(string Entidade, RhpBEInstituicaoHistorico.EnumTipoInstituicao Instituicao)

Parameters

Type	Name	Description
System.String	Entidade	Identificador de entidade a pesquisar.
RhpBEInstituicaoHistorico.EnumTipoInstituicao	Instituicao

Returns

Type	Description
System.DateTime

DaValorAtributo(String, String)

Devolve o valor de um atributo.

Declaration

object DaValorAtributo(string ID, string Atributo)

Parameters

Type	Name	Description
System.String	ID	Identificador do desconto da apólice.
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 ID, string Atributo)

Parameters

Type	Name	Description
System.String	ID	Identificador do desconto da apólice.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

Type	Description
System.Object

DaValorAtributoLogico(String, RhpBEInstituicaoHistorico.EnumTipoInstituicao, DateTime, String)

Devolve o valor de um atributo através de uma chave alternativa (lógica).

Declaration

object DaValorAtributoLogico(string Entidade, RhpBEInstituicaoHistorico.EnumTipoInstituicao Instituicao, DateTime Data, string Atributo)

Parameters

Type	Name	Description
System.String	Entidade	Código da Entidade a procurar atributo.
RhpBEInstituicaoHistorico.EnumTipoInstituicao	Instituicao	Tipo de manutenão (tabela). 1 - CGA; 2 - Fundo de Pensões; 3- Sindicatos.
System.DateTime	Data	a partir da qual vigoram os descontos.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

Type	Description
System.Object

DaValorAtributoLogicoLock(String, RhpBEInstituicaoHistorico.EnumTipoInstituicao, DateTime, String)

Devolve o valor de um atributo através de uma chave alternativa (lógica), respeitando os locks da base de dados.

Declaration

object DaValorAtributoLogicoLock(string Entidade, RhpBEInstituicaoHistorico.EnumTipoInstituicao Instituicao, DateTime Data, string Atributo)

Parameters

Type	Name	Description
System.String	Entidade	Código da Entidade a procurar atributo.
RhpBEInstituicaoHistorico.EnumTipoInstituicao	Instituicao	Tipo de manutenão (tabela). 1 - CGA; 2 - Fundo de Pensões; 3- Sindicatos.
System.DateTime	Data	a partir da qual vigoram os descontos.
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 ID, string[] Atributos)

Parameters

Type	Name	Description
System.String	ID	Identificador do desconto da apólice.
System.String[]	Atributos	Conjunto de atributos dos quais se pretende obter 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 ID, string[] Atributos)

Parameters

Type	Name	Description
System.String	ID	Identificador do desconto da apólice.
System.String[]	Atributos	Conjunto de atributos dos quais se pretende obter o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosLogico(String, RhpBEInstituicaoHistorico.EnumTipoInstituicao, DateTime, String[])

Devolve o valor de um conjunto de atributos através de uma chave alternativa (lógica).

Declaration

StdBECampos DaValorAtributosLogico(string Entidade, RhpBEInstituicaoHistorico.EnumTipoInstituicao Instituicao, DateTime Data, string[] Atributos)

Parameters

Type	Name	Description
System.String	Entidade	Código da Entidade a procurar atributos.
RhpBEInstituicaoHistorico.EnumTipoInstituicao	Instituicao	Tipo de manutenão (tabela). 1 - CGA; 2 - Fundo de Pensões; 3- Sindicatos.
System.DateTime	Data	a partir da qual vigoram os descontos.
System.String[]	Atributos	Conjunto de atributos dos quais se pretende obter o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosLogicoLock(String, RhpBEInstituicaoHistorico.EnumTipoInstituicao, DateTime, String[])

Devolve o valor de um conjunto de atributos através de uma chave alternativa (lógica), respeitando os locks da base de dados.

Declaration

StdBECampos DaValorAtributosLogicoLock(string Entidade, RhpBEInstituicaoHistorico.EnumTipoInstituicao Instituicao, DateTime Data, string[] Atributos)

Parameters

Type	Name	Description
System.String	Entidade	Código da Entidade a procurar atributos.
RhpBEInstituicaoHistorico.EnumTipoInstituicao	Instituicao	Tipo de manutenão (tabela). 1 - CGA; 2 - Fundo de Pensões; 3- Sindicatos.
System.DateTime	Data	a partir da qual vigoram os descontos.
System.String[]	Atributos	Conjunto de atributos dos quais se pretende obter o valor.

Returns

Type	Description
StdBECampos

Edita(String, RhpBEInstituicaoHistorico.EnumTipoInstituicao, DateTime)

Edita a informação dos Descontos de uma instituição numa daterminada data ou na imediatamente anterior.

Declaration

RhpBEInstituicaoHistorico Edita(string Entidade, RhpBEInstituicaoHistorico.EnumTipoInstituicao Instituicao, DateTime Data)

Parameters

Type	Name	Description
System.String	Entidade	Código da Entidade a editar.
RhpBEInstituicaoHistorico.EnumTipoInstituicao	Instituicao	Tipo de manutenão (tabela). 1 - CGA; 2 - Fundo de Pensões; 3- Sindicatos.
System.DateTime	Data	a partir da qual vigoram os descontos.

Returns

Type	Description
RhpBEInstituicaoHistorico

EditaInstituicoesHistorico(String, Int32, DateTime)

Edita a informação dos Descontos de uma instituição.

Declaration

RhpBEInstituicaoHistoricos EditaInstituicoesHistorico(string Entidade, int Instituicao = 0, DateTime Data = default(DateTime))

Parameters

Type	Name	Description
System.String	Entidade	Código da Entidade a editar.
System.Int32	Instituicao	Tipo de manutenão (tabela). 1 - CGA; 2 - Fundo de Pensões; 3- Sindicatos. Objecto do tipo: EnumTipoInstituicao.
System.DateTime	Data	a partir da qual vigoram os descontos.

Returns

Type	Description
RhpBEInstituicaoHistoricos

Existe(String, RhpBEInstituicaoHistorico.EnumTipoInstituicao, DateTime)

Verifica se existe um desconto da apólice.

Declaration

bool Existe(string Entidade, RhpBEInstituicaoHistorico.EnumTipoInstituicao Instituicao, DateTime Data)

Parameters

Type	Name	Description
System.String	Entidade	Código da Entidade.
RhpBEInstituicaoHistorico.EnumTipoInstituicao	Instituicao
System.DateTime	Data	em que vigoram os descontos.

Returns

Type	Description
System.Boolean

ExisteID(String)

Verifica se existe um desconto da apólice através de um identificador.

Declaration

bool ExisteID(string ID)

Parameters

Type	Name	Description
System.String	ID	Identificador do desconto na apólice.

Returns

Type	Description
System.Boolean

LstInstituicaoHistorico(String, Int32, DateTime)

Listagens de todos os descontos ao longo do tempo de uma ou todas as instituicoes

Declaration

StdBELista LstInstituicaoHistorico(string Entidade = "", int Instituicao = 0, DateTime Data = default(DateTime))

Parameters

Type	Name	Description
System.String	Entidade	Código da Entidade.
System.Int32	Instituicao	Tipo de manutenão (tabela). 1 - CGA; 2 - Fundo de Pensões; 3- Sindicatos. Objecto do tipo: EnumTipoInstituicao.
System.DateTime	Data	a partir da qual vigoram os descontos.

Returns

Type	Description
StdBELista

Remove(String, RhpBEInstituicaoHistorico.EnumTipoInstituicao, DateTime)

Remove os descontos de uma instituição, numa determinada data.

Declaration

void Remove(string Entidade, RhpBEInstituicaoHistorico.EnumTipoInstituicao Instituicao, DateTime Data)

Parameters

Type	Name	Description
System.String	Entidade	Código da Entidade.
RhpBEInstituicaoHistorico.EnumTipoInstituicao	Instituicao	Tipo de manutenão (tabela). 1 - CGA; 2 - Fundo de Pensões; 3- Sindicatos.
System.DateTime	Data	a partir da qual vigoram os descontos.

RemoveID(String)

Remove os descontos de uma instituição.

Declaration

void RemoveID(string ID)

Parameters

Type	Name	Description
System.String	ID	Identificador (ID) dos descontos de uma instituição.

RemoveInstituicoesHistorico(String, RhpBEInstituicaoHistorico.EnumTipoInstituicao)

Remove todos os descontos de uma instituição.

Declaration

void RemoveInstituicoesHistorico(string Entidade, RhpBEInstituicaoHistorico.EnumTipoInstituicao Instituicao)

Parameters

Type	Name	Description
System.String	Entidade	Código da Entidade.
RhpBEInstituicaoHistorico.EnumTipoInstituicao	Instituicao	Tipo de manutenão (tabela). 1 - CGA; 2 - Fundo de Pensões; 3- Sindicatos.

ValidaActualizacao(RhpBEInstituicaoHistorico, ref String)

Efectua a validação da informação de descontos de uma instituição.

Declaration

bool ValidaActualizacao(RhpBEInstituicaoHistorico objInstituicaoHistorico, ref string ErroValidacao)

Parameters

Type	Name	Description
RhpBEInstituicaoHistorico	objInstituicaoHistorico
System.String	ErroValidacao	Recebe a descrição de eventuais erros detectados.

Returns

Type	Description
System.Boolean

ValidaActualizacaoInstituicaoHistoricos(RhpBEInstituicaoHistoricos, ref String, ref String)

Efectua a validação de um conjunto de informação de descontos de uma instituição.

Declaration

bool ValidaActualizacaoInstituicaoHistoricos(RhpBEInstituicaoHistoricos objInstituicoesHistorico, ref string strErro, ref string strAviso)

Parameters

Type	Name	Description
RhpBEInstituicaoHistoricos	objInstituicoesHistorico
System.String	strErro	Recebe a descrição de eventuais erros detectados.
System.String	strAviso	Recebe a descrição de eventuais avisos.

Returns

Type	Description
System.Boolean

ValidaRemocao(String, ref String)

Efectua as validações necessárias à remoção de descontos de uma instituição.

Declaration

bool ValidaRemocao(string ID, ref string ErroValidacao)

Parameters

Type	Name	Description
System.String	ID	Identificador de descontos de uma instituição.
System.String	ErroValidacao	Recebe a descrição de eventuais erros detectados.

Returns

Type	Description
System.Boolean

ValidaRemocaoInstituicoesHistorico(String, RhpBEInstituicaoHistorico.EnumTipoInstituicao, String)

Efectua as validações necessárias à remoção de descontos de uma instituição.

Declaration

bool ValidaRemocaoInstituicoesHistorico(string Entidade, RhpBEInstituicaoHistorico.EnumTipoInstituicao Instituicao, string ErroValidacao)

Parameters

Type	Name	Description
System.String	Entidade	Identificador de uma instituição.
RhpBEInstituicaoHistorico.EnumTipoInstituicao	Instituicao	Tipo de manutenão (tabela). 1 - CGA; 2 - Fundo de Pensões; 3- Sindicatos.
System.String	ErroValidacao	Recebe a descrição de eventuais erros detectados.

Returns

Type	Description
System.Boolean