Interface IRhpBSCGA
Classe utilizada para obter as regras de negócio dos registos da Caixa Geral de Aposentações.
Namespace: IRhpBS100
Assembly: IRhpBS100.dll
Syntax
[ComVisible(true)]
[Guid("71C44086-CF8C-4C19-9CC5-5364F8487BB0")]
public interface IRhpBSCGA
Methods
Actualiza(RhpBECGA)
Actualiza a informação de um registo de Caixa Geral de Aposentações.
Declaration
void Actualiza(RhpBECGA objBECGA)
Parameters
Type | Name | Description |
---|---|---|
RhpBECGA | objBECGA | Objecto contendo os valores actuais. |
Actualiza(RhpBECGA, ref String)
Actualiza a informação de um registo de Caixa Geral de Aposentações.
Declaration
void Actualiza(RhpBECGA objBECGA, ref string strAviso)
Parameters
Type | Name | Description |
---|---|---|
RhpBECGA | objBECGA | 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 CGA, string Atributo, object Valor)
Parameters
Type | Name | Description |
---|---|---|
System.String | CGA | Identificador da Caixa Geral de Aposentações. |
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 CGA, StdBECampos Atributos)
Parameters
Type | Name | Description |
---|---|---|
System.String | CGA | Identificador da Caixa Geral de Aposentações. |
StdBECampos | Atributos | Objecto contendo os atributos a actualizar e respectivos valores. |
DaDefCamposUtil()
Devolve as definições dos campos do utilizador.
Declaration
StdBEDefCamposUtil DaDefCamposUtil()
Returns
Type | Description |
---|---|
StdBEDefCamposUtil |
DaDescontos(String, ref Double, ref Double)
Devolve por referência, o conjunto de descontos.
Declaration
bool DaDescontos(string CGA, ref double DescontoEmpresa, ref double DescontoEmpregado)
Parameters
Type | Name | Description |
---|---|---|
System.String | CGA | Identificador da Caixa Geral de Aposentações. |
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 |
DaDescontosHistorico(String, DateTime, out Double, out Double)
Devolve os Descontos por referência, de um Identificador da Caixa Geral de Aposentações que vigoram numa determinada Data.
Declaration
bool DaDescontosHistorico(string CGA, DateTime Data, out double DescontoEmpresa, out double DescontoEmpregado)
Parameters
Type | Name | Description |
---|---|---|
System.String | CGA | Identificador da Caixa Geral de Aposentações. |
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 |
DaUltimaDataAplicacao(String)
Devolve a data que vigora (última) de um Identificador da Caixa Geral de Aposentações.
Declaration
DateTime DaUltimaDataAplicacao(string CGA)
Parameters
Type | Name | Description |
---|---|---|
System.String | CGA | Identificador da Caixa Geral de Aposentações. |
Returns
Type | Description |
---|---|
System.DateTime |
DaValorAtributo(String, String)
Devolve o valor de um atributo.
Declaration
object DaValorAtributo(string CGA, string Atributo)
Parameters
Type | Name | Description |
---|---|---|
System.String | CGA | Identificador da Caixa Geral de Aposentações. |
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 CGA, string Atributo)
Parameters
Type | Name | Description |
---|---|---|
System.String | CGA | Identificador da Caixa Geral de Aposentações. |
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 CGA, params string[] Atributos)
Parameters
Type | Name | Description |
---|---|---|
System.String | CGA | Identificador da Caixa Geral de Aposentações. |
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 CGA, params string[] Atributos)
Parameters
Type | Name | Description |
---|---|---|
System.String | CGA | Identificador da Caixa Geral de Aposentações. |
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 registo de Caixa Geral de Aposentações.
Declaration
RhpBECGA Edita(string CGA)
Parameters
Type | Name | Description |
---|---|---|
System.String | CGA | Identificador da Caixa Geral de Aposentações. |
Returns
Type | Description |
---|---|
RhpBECGA |
Existe(String)
Verifica se existe o registo referente à informação passada nos parâmetros.
Declaration
bool Existe(string CGA)
Parameters
Type | Name | Description |
---|---|---|
System.String | CGA | Identificador da Caixa Geral de Aposentações. |
Returns
Type | Description |
---|---|
System.Boolean |
LstCGA()
Devolve uma listagem de registos de Caixa Geral de Aposentações.
Declaration
StdBELista LstCGA()
Returns
Type | Description |
---|---|
StdBELista |
Remove(String)
Remove a informação de um registo de Caixa Geral de Aposentações.
Declaration
void Remove(string CGA)
Parameters
Type | Name | Description |
---|---|---|
System.String | CGA | Identificador da Caixa Geral de Aposentações. |
ValidaActualizacao(RhpBECGA, ref String, ref String)
Efectua a validação de actualização dos dados de um registo.
Declaration
bool ValidaActualizacao(RhpBECGA ObjCGA, ref string ErroValidacao, ref string AvisoValidacao)
Parameters
Type | Name | Description |
---|---|---|
RhpBECGA | ObjCGA | 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 CGA, ref string ErroValidacao)
Parameters
Type | Name | Description |
---|---|---|
System.String | CGA | Identificador da Caixa Geral de Aposentações. |
System.String | ErroValidacao | Recebe a descrição de eventuais erros detectados. |
Returns
Type | Description |
---|---|
System.Boolean |