Interface IRhpBSCadastroSegSocial
Classe utilizada para obter as regras de negócio do Cadastro de registos da Segurança Social.
Namespace: IRhpBS100
Assembly: IRhpBS100.dll
Syntax
[ComVisible(true)]
[Guid("A477E8B9-462D-48B1-A535-A6D87913F70D")]
public interface IRhpBSCadastroSegSocial
Methods
Actualiza(RhpBECadastroSegSocial)
Actualiza a informação de um registo de cadastro de segurança social.
Declaration
void Actualiza(RhpBECadastroSegSocial objBECadastroSegSocial)
Parameters
Type | Name | Description |
---|---|---|
RhpBECadastroSegSocial | objBECadastroSegSocial | Objecto contendo os valores actuais. |
ActualizaValorAtributo(Int32, String, Object)
Actualiza o valor de um atributo.
Declaration
void ActualizaValorAtributo(int Chave, string Atributo, object Valor)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Chave | Identificador do cadastro de segurança social. |
System.String | Atributo | Nome do atributo cujo valor será actualizado. |
System.Object | Valor | Novo valor do atributo indicado. |
ActualizaValorAtributos(Int32, StdBECampos)
Actualiza os valores respectivos de um conjunto de atributos.
Declaration
void ActualizaValorAtributos(int Chave, StdBECampos Atributos)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Chave | Identificador do cadastro de segurança social. |
StdBECampos | Atributos | Objecto contendo os atributos a actualizar e respectivos valores. |
AtualizaCadastros(Int16, Byte, IEnumerable<RhpBECadastroSegSocial>, IEnumerable<RhpBECadastroSegSocial>, out List<RhpBEErroAlertaSS>)
Actualiza os registos do cadastro devolvendo lista de erros
Declaration
bool AtualizaCadastros(short Ano, byte Mes, IEnumerable<RhpBECadastroSegSocial> ListaCadastros, IEnumerable<RhpBECadastroSegSocial> ListaRemovidos, out List<RhpBEErroAlertaSS> Erros)
Parameters
Type | Name | Description |
---|---|---|
System.Int16 | Ano | Ano |
System.Byte | Mes | Mês |
System.Collections.Generic.IEnumerable<RhpBECadastroSegSocial> | ListaCadastros | Lista de RhpBECadastroSegSocial do período |
System.Collections.Generic.IEnumerable<RhpBECadastroSegSocial> | ListaRemovidos | Lista de registos RhpBECadastroSegSocial removidos |
System.Collections.Generic.List<RhpBEErroAlertaSS> | Erros | Erros e validações que ocorreram |
Returns
Type | Description |
---|---|
System.Boolean |
DaDefCamposUtil()
Devolve as definições dos campos do utilizador.
Declaration
StdBEDefCamposUtil DaDefCamposUtil()
Returns
Type | Description |
---|---|
StdBEDefCamposUtil |
DaValorAtributo(Int32, String)
Devolve o valor de um atributo.
Declaration
object DaValorAtributo(int Chave, string Atributo)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Chave | Identificador do cadastro de segurança social. |
System.String | Atributo | Nome do atributo cujo valor será devolvido. |
Returns
Type | Description |
---|---|
System.Object |
DaValorAtributos(Int32, String[])
Devolve o valor de um conjunto de atributos.
Declaration
StdBECampos DaValorAtributos(int Chave, params string[] Atributos)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Chave | Identificador do cadastro de segurança social. |
System.String[] | Atributos | Conjunto de atributos dos quais se pretende devolver o valor. |
Returns
Type | Description |
---|---|
StdBECampos |
Edita(Int32)
Edita a informação de um registo de cadastro de segurança social.
Declaration
RhpBECadastroSegSocial Edita(int Chave)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Chave | Identificador do cadastro de segurança social. |
Returns
Type | Description |
---|---|
RhpBECadastroSegSocial |
Existe(Int32)
Verifica se existe o registo referente à informação passada nos parâmetros.
Declaration
bool Existe(int Chave)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Chave | Identificador do cadastro de segurança social. |
Returns
Type | Description |
---|---|
System.Boolean |
ListaCadastro(Int16, Byte, String)
Devolve uma lista de registos do cadastro para um periodo
Declaration
List<RhpBECadastroSegSocial> ListaCadastro(short Ano, byte Mes, string Restricoes)
Parameters
Type | Name | Description |
---|---|---|
System.Int16 | Ano | |
System.Byte | Mes | |
System.String | Restricoes | Restricoes a aplicar |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<RhpBECadastroSegSocial> |
LstCadastroSegSocial()
Devolve uma listagem de registos de cadastro de segurança social.
Declaration
StdBELista LstCadastroSegSocial()
Returns
Type | Description |
---|---|
StdBELista |
Remove(Int32)
Remove a informação de um registo de cadastro de segurança social.
Declaration
void Remove(int Chave)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Chave | Identificador do cadastro de segurança social. |
ValidaActualizacao(RhpBECadastroSegSocial, ref String)
Efectua a validação de actualização dos dados de um registo.
Declaration
bool ValidaActualizacao(RhpBECadastroSegSocial ObjCadastroSegSocial, ref string ErroValidacao)
Parameters
Type | Name | Description |
---|---|---|
RhpBECadastroSegSocial | ObjCadastroSegSocial | 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, ref String)
Efectua a validação de um registo antes de ser efectuada a sua remoção.
Declaration
bool ValidaRemocao(int Chave, ref string ErroValidacao)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Chave | Identificador do cadastro de segurança social. |
System.String | ErroValidacao | Recebe a descrição de eventuais erros detectados. |
Returns
Type | Description |
---|---|
System.Boolean |