Interface IImoBSHistoricoApoliceEncargo

IImoBSHistoricoApoliceEncargo - Classe utilizada para obter as regras de negócio do histórico dos encargos das Apolices de seguro.

Namespace: IEapBS100

Assembly: IEapBS100.dll

Syntax

[ComVisible(true)]
[Guid("9B043385-3D38-4922-80C2-92D727AA288B")]
public interface IImoBSHistoricoApoliceEncargo

Methods

Actualiza(ImoBEHistoricoApoliceEncargo)

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

Declaration

void Actualiza(ImoBEHistoricoApoliceEncargo objHistoricoApolice)

Parameters

Type	Name	Description
ImoBEHistoricoApoliceEncargo	objHistoricoApolice	Objecto com dados actuais escontos de uma instituição numa data

ActualizaHistoricoApoliceEncargos(ImoBEHistoricoApoliceEncargos)

Método que permite criar/actualizar uma colecção com o histórico dos descontos contidos nos objectos BEHistoricoApoliceEncargo

Declaration

void ActualizaHistoricoApoliceEncargos(ImoBEHistoricoApoliceEncargos objHistoricoApolices)

Parameters

Type	Name	Description
ImoBEHistoricoApoliceEncargos	objHistoricoApolices	Colecção com o historico de descontos de uma Apólice de suguros.

ActualizaHistoricoApoliceEncargos(ImoBEHistoricoApoliceEncargos, ref String)

Método que permite criar/actualizar uma colecção com o histórico dos descontos contidos nos objectos BEHistoricoApoliceEncargo

Declaration

void ActualizaHistoricoApoliceEncargos(ImoBEHistoricoApoliceEncargos objHistoricoApolices, ref string strAviso)

Parameters

Type	Name	Description
ImoBEHistoricoApoliceEncargos	objHistoricoApolices	Colecção com o historico de descontos de uma Apólice de suguros.
System.String	strAviso	Recebe a descrição de 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 apólice.
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, DateTime, ref Double, ref Double, ref Boolean, ref String)

Devolve por referência, os Descontos de uma Entidade em vigor numa determinada Data.

Declaration

bool DaDescontosHistorico(string IDApolice, DateTime Data, ref double DescontoEmpresa, ref double DescontoEmpregado, ref bool Percentual, ref string Moeda)

Parameters

Type	Name	Description
System.String	IDApolice	Identificador da apólice.
System.DateTime	Data	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	Variável que será preenchida com a moeda do desconto.

Returns

Type	Description
System.Boolean

DaDescontosHistoricoEx(String, DateTime, ref Double, ref Double, ref Boolean, ref String, ref Boolean)

Devolve por referência, os Descontos de uma Entidade em vigor numa determinada Data.

Declaration

bool DaDescontosHistoricoEx(string IDApolice, DateTime Data, ref double DescontoEmpresa, ref double DescontoEmpregado, ref bool Percentual, ref string Moeda, ref bool DiasTrabalhados)

Parameters

Type	Name	Description
System.String	IDApolice	Identificador da apólice.
System.DateTime	Data	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	Variável que será preenchida com a moeda do desconto.
System.Boolean	DiasTrabalhados	Variável que será preenchida com o valor TRUE se o valor for proporcional aos dias trabalhados.

Returns

Type	Description
System.Boolean

DaUltimaDataAplicacao(String)

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

Declaration

DateTime DaUltimaDataAplicacao(string IDApolice)

Parameters

Type	Name	Description
System.String	IDApolice	Identificador da apólice.

Returns

Type	Description
System.DateTime

DaValorAtributo(String, String)

Devolve o valor de um atributo.

Declaration

dynamic 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

DaValorAtributoLogico(String, DateTime, String)

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

Declaration

dynamic DaValorAtributoLogico(string IDApolice, DateTime Data, string Atributo)

Parameters

Type	Name	Description
System.String	IDApolice
System.DateTime	Data	Data em que 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, params 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, DateTime, String[])

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

Declaration

StdBECampos DaValorAtributosLogico(string IDApolice, DateTime Data, params string[] Atributos)

Parameters

Type	Name	Description
System.String	IDApolice
System.DateTime	Data	Data em que vigoram os descontos.
System.String[]	Atributos	Conjunto de atributos dos quais se pretende obter o valor.

Returns

Type	Description
StdBECampos

Edita(String, DateTime)

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

Declaration

ImoBEHistoricoApoliceEncargo Edita(string IDApolice, DateTime Data)

Parameters

Type	Name	Description
System.String	IDApolice
System.DateTime	Data	Data em que vigoram os descontos.

Returns

Type	Description
ImoBEHistoricoApoliceEncargo

EditaInstituicoesHistorico(String)

Edita a informação dos Descontos de uma apólice.

Declaration

ImoBEHistoricoApoliceEncargos EditaInstituicoesHistorico(string IDApolice)

Parameters

Type	Name	Description
System.String	IDApolice

Returns

Type	Description
ImoBEHistoricoApoliceEncargos

EditaInstituicoesHistorico(String, DateTime)

Edita a informação dos Descontos de uma apólice.

Declaration

ImoBEHistoricoApoliceEncargos EditaInstituicoesHistorico(string IDApolice, DateTime Data)

Parameters

Type	Name	Description
System.String	IDApolice
System.DateTime	Data	Data (opcional) caso exista filtra os descontos até essa data.

Returns

Type	Description
ImoBEHistoricoApoliceEncargos

Existe(String, DateTime)

Verifica se existe um desconto da apólice.

Declaration

bool Existe(string IDApolice, DateTime Data)

Parameters

Type	Name	Description
System.String	IDApolice
System.DateTime	Data	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

LstHistoricoApoliceEncargo(String)

Listagens de todos os descontos ao longo do tempo de uma ou todas as Apólice.

Declaration

StdBELista LstHistoricoApoliceEncargo(string IDApolice)

Parameters

Type	Name	Description
System.String	IDApolice

Returns

Type	Description
StdBELista

LstHistoricoApoliceEncargo(String, DateTime)

Listagens de todos os descontos ao longo do tempo de uma ou todas as Apólice.

Declaration

StdBELista LstHistoricoApoliceEncargo(string IDApolice, DateTime Data)

Parameters

Type	Name	Description
System.String	IDApolice
System.DateTime	Data	Data em que vigoram os descontos.

Returns

Type	Description
StdBELista

Remove(String, DateTime)

Remove os descontos de uma apólice, numa determinada data.

Declaration

void Remove(string IDApolice, DateTime Data)

Parameters

Type	Name	Description
System.String	IDApolice
System.DateTime	Data	Data em que vigoram os descontos.

RemoveID(String)

Remove os descontos de uma apólice.

Declaration

void RemoveID(string ID)

Parameters

Type	Name	Description
System.String	ID	Identificador (ID) dos descontos de uma apólice.

RemoveInstituicoesHistorico(String)

Remove todos os descontos de uma apólice.

Declaration

void RemoveInstituicoesHistorico(string IDApolice)

Parameters

Type	Name	Description
System.String	IDApolice

ValidaActualizacao(ImoBEHistoricoApoliceEncargo, ref String)

Efectua a validação da informação de descontos de uma apólice.

Declaration

bool ValidaActualizacao(ImoBEHistoricoApoliceEncargo objHistoricoApolice, ref string ErroValidacao)

Parameters

Type	Name	Description
ImoBEHistoricoApoliceEncargo	objHistoricoApolice	Objecto contendo a informação que se pretende validar.
System.String	ErroValidacao	Recebe a descrição de eventuais erros detectados.

Returns

Type	Description
System.Boolean

ValidaActualizacaoHistoricoApoliceEncargos(String, ImoBEHistoricoApoliceEncargos, ref String, ref String)

Efectua a validação de um conjunto de informação de descontos de uma apólice.

Declaration

bool ValidaActualizacaoHistoricoApoliceEncargos(string strIDApolice, ImoBEHistoricoApoliceEncargos objHistApolEncargos, ref string ErroValidacao, ref string AvisoValidacao)

Parameters

Type	Name	Description
System.String	strIDApolice
ImoBEHistoricoApoliceEncargos	objHistApolEncargos	Objecto contendo a colecção da informação que se pretende validar.
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 as validações necessárias à remoção de descontos de uma apólice.

Declaration

bool ValidaRemocao(string ID, ref string ErroValidacao)

Parameters

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

Returns

Type	Description
System.Boolean

ValidaRemocaoInstituicoesHistorico(String, String)

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

Declaration

bool ValidaRemocaoInstituicoesHistorico(string IDApolice, string ErroValidacao)

Parameters

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

Returns

Type	Description
System.Boolean