Interface IRhpBsProcessosDivida

Esta classe deve ser usada para obter regras de negócio sobre RHPProcessoDividas

Namespace: IRhpBS100

Assembly: IRhpBS100.dll

Syntax

[ComVisible(true)]
[Guid("52C99381-4E5A-4AAA-AF30-F53A095BF6DB")]
public interface IRhpBsProcessosDivida

Methods

Actualiza(RhpBEProcessoDivida, ref String)

Actualiza o RHPProcessoDividas na base de dados

Declaration

void Actualiza(RhpBEProcessoDivida objBE, ref string Avisos)

Parameters

Type	Name	Description
RhpBEProcessoDivida	objBE	Objecto que identifica o RHP_ProcessoDividas a actualizar
System.String	Avisos

ActualizaValorAtributo(String, String, String, Object)

Permite efectuar a actualização de um atributo de um determinado Processo de Divida

Declaration

void ActualizaValorAtributo(string Funcionario, string Referencia, string Atributo, object Valor)

Parameters

Type	Name	Description
System.String	Funcionario	Código do Funcionário
System.String	Referencia	Referência do processo de dívida
System.String	Atributo	Nome do campo a actualizar
System.Object	Valor	Valor do campo a actualizar

ActualizaValorAtributoID(String, String, Object)

Declaration

void ActualizaValorAtributoID(string ID, string Atributo, object Valor)

Parameters

Type	Name	Description
System.String	ID	Identificador do processo de dividaentificado do processo de dívida
System.String	Atributo	Nome do campo a actualizar
System.Object	Valor	Valor do campo a actualizar

ActualizaValorAtributos(String, String, StdBECampos)

Permite efectuar a actualização de um conjunto de atributos de um determinado Processo de Divida

Declaration

void ActualizaValorAtributos(string Funcionario, string Referencia, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	Funcionario	Código do Funcionário
System.String	Referencia	Referência do processo de dívida
StdBECampos	Atributos	Atributos e respectivos valores a actualizar

ActualizaValorAtributosID(String, StdBECampos)

Permite efectuar a actualização de um conjunto de atributos de um determinado Processo de Divida pelo identificador

Declaration

void ActualizaValorAtributosID(string ID, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	ID	Identificador do processo de divida
StdBECampos	Atributos	Atributos e respectivos valores a actualizar

CalculaValorProcessoDivida(RhpBEProcessoDivida, RhpBEProcessamento, RhpBEFuncionario, Double, Double, Double, Double)

Calcula o valor de um processo de dívida.

Declaration

double CalculaValorProcessoDivida(RhpBEProcessoDivida ProcessoDivida, RhpBEProcessamento Processamento, RhpBEFuncionario Funcionario, double RemuneracaoLiquida, double ValorJaProcPeriodo, double ValorProcessosAnteriores, double PercentagemTranche)

Parameters

Type	Name	Description
RhpBEProcessoDivida	ProcessoDivida	Processo de Dívida
RhpBEProcessamento	Processamento	Processamento que está a ser efectuado
RhpBEFuncionario	Funcionario	Funcionário
System.Double	RemuneracaoLiquida	Valor da remuneração liquida apurada
System.Double	ValorJaProcPeriodo	Valor já processado no mês
System.Double	ValorProcessosAnteriores	Valor já processado no mês de processos anteriores
System.Double	PercentagemTranche	Percentagem de tranche

Returns

Type	Description
System.Double

CalculaValorProcessoDividaEx(RhpBEProcessoDivida, RhpBEProcessamento, RhpBEFuncionario, Double, Double, Double, Double, Double)

Calcula o valor de um processo de dívida.

Declaration

double CalculaValorProcessoDividaEx(RhpBEProcessoDivida ProcessoDivida, RhpBEProcessamento Processamento, RhpBEFuncionario Funcionario, double RemuneracaoLiquida, double ValorDescontos, double ValorJaProcPeriodo, double ValorProcessosAnteriores, double PercentagemTranche)

Parameters

Type	Name	Description
RhpBEProcessoDivida	ProcessoDivida	Processo de Dívida
RhpBEProcessamento	Processamento	Processamento que está a ser efectuado
RhpBEFuncionario	Funcionario	Funcionário
System.Double	RemuneracaoLiquida	Valor da remuneração liquida apurada
System.Double	ValorDescontos	Valor dos descontos considerados
System.Double	ValorJaProcPeriodo	Valor já processado no mês
System.Double	ValorProcessosAnteriores	Valor já processado no mês de processos anteriores
System.Double	PercentagemTranche	Percentagem de tranche

Returns

Type	Description
System.Double

DaDefCamposUtil()

Devolve as definições dos campos do utilizador de ID associados ao RHPProcessoDividas

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

Type	Description
StdBEDefCamposUtil

DaValorAtributo(String, String, String)

Devolve o valor de um atributo do Processo de Divida

Declaration

object DaValorAtributo(string Funcionario, string Referencia, string Atributo)

Parameters

Type	Name	Description
System.String	Funcionario	Código do Funcionário
System.String	Referencia	Referência do processo de dívida
System.String	Atributo	Atributo que se pretende obter o valor

Returns

Type	Description
System.Object

DaValorAtributoID(String, String)

Devolve o valor de um determinado atributo do Processo de Divida pelo identificador

Declaration

object DaValorAtributoID(string ID, string Atributo)

Parameters

Type	Name	Description
System.String	ID	Identificador do processo de divida
System.String	Atributo	Atributo que se pretende obter o valor

Returns

Type	Description
System.Object

DaValorAtributos(String, String, String[])

Devolve os valores de um conjunto de atributos do Processo de Divida

Declaration

StdBECampos DaValorAtributos(string Funcionario, string Referencia, params string[] Atributos)

Parameters

Type	Name	Description
System.String	Funcionario	Código do Funcionário
System.String	Referencia	Referência do processo de dívida
System.String[]	Atributos	Atributos para os quais se pretende devolver os valores

Returns

Type	Description
StdBECampos

DaValorAtributosID(String, String[])

Devolve os valores de um conjunto de atributos do Processo de Divida pelo identificador

Declaration

StdBECampos DaValorAtributosID(string ID, params string[] Atributos)

Parameters

Type	Name	Description
System.String	ID	Identificador do processo de divida
System.String[]	Atributos	Atributos para os quais se pretende devolver os valores

Returns

Type	Description
StdBECampos

DaValorProcessadoPelosMovimentos(String, String)

Devolve total já processado para um processo de dívida calculado pelos movimentos processados.

Declaration

double DaValorProcessadoPelosMovimentos(string Funcionario, string IdProcessoDivida)

Parameters

Type	Name	Description
System.String	Funcionario	Código do Funcionário
System.String	IdProcessoDivida	Identificador do processo de dívida

Returns

Type	Description
System.Double

DevolveDadosIntegracao(String, ref Byte, ref String)

Devolve informação de integração na contabilidade e contas correntes relativas ao processo de dívida

Declaration

bool DevolveDadosIntegracao(string IdProcessoDivida, ref byte TipoEntExec, ref string EntExecutante)

Parameters

Type	Name	Description
System.String	IdProcessoDivida
System.Byte	TipoEntExec	(Saída) Tipo de entidade
System.String	EntExecutante	(Saída) Entidade

Returns

Type	Description
System.Boolean

DevolveDadosIntegracao(String, ref Byte, ref String, ref String)

Devolve informação de integração na contabilidade e contas correntes relativas ao processo de dívida

Declaration

bool DevolveDadosIntegracao(string IdProcessoDivida, ref byte TipoEntExec, ref string EntExecutante, ref string Referencia)

Parameters

Type	Name	Description
System.String	IdProcessoDivida
System.Byte	TipoEntExec	(Saída) Tipo de entidade
System.String	EntExecutante	(Saída) Entidade
System.String	Referencia	(Saida) Referência

Returns

Type	Description
System.Boolean

DevolveDadosIntegracao(String, ref Byte, ref String, ref String, ref String)

Devolve informação de integração na contabilidade e contas correntes relativas ao processo de dívida

Declaration

bool DevolveDadosIntegracao(string IdProcessoDivida, ref byte TipoEntExec, ref string EntExecutante, ref string Referencia, ref string RefPagamento)

Parameters

Type	Name	Description
System.String	IdProcessoDivida
System.Byte	TipoEntExec	(Saída) Tipo de entidade
System.String	EntExecutante	(Saída) Entidade
System.String	Referencia	(Saida) Referência
System.String	RefPagamento	(Saida) Referência para pagamento

Returns

Type	Description
System.Boolean

DevolveExtrato(DateTime, DateTime, String, String, String)

Devolve lista de todos os movimentos do extrato de processos de dívida

Declaration

StdBELista DevolveExtrato(DateTime DataInicial, DateTime DataFinal, string RestricoesProcessoDivida, string CamposSelect, string CamposGroupBy)

Parameters

Type	Name	Description
System.DateTime	DataInicial	Data inicial do extrato
System.DateTime	DataFinal	Data final do extrato
System.String	RestricoesProcessoDivida	Restrições a aplicar ao extrato
System.String	CamposSelect	Campos a retornar do extrato
System.String	CamposGroupBy

Returns

Type	Description
StdBELista

DevolveValoresProcessados(String, Boolean, Boolean, Boolean, Int32, Int32, Int32)

Devolve lista de todos os valores processados no período fiscal

Declaration

StdBELista DevolveValoresProcessados(string Funcionario, bool VencimentoOutros, bool SubFerias, bool SubNatal, int Ano, int Mes = 0, int NumProcLimite = 0)

Parameters

Type	Name	Description
System.String	Funcionario	Código do Funcionário
System.Boolean	VencimentoOutros	Indica se deve incluir valores de vencimentos, extraordinários e outros (Excepto subsidios)
System.Boolean	SubFerias	Indica se deve incluir valores de subsidio de férias
System.Boolean	SubNatal	Indica se deve incluir valores de subsidio de natal
System.Int32	Ano	Ano
System.Int32	Mes	Mes fiscal de referência (opcional 0 para todos)
System.Int32	NumProcLimite	Número de Processamento Limite

Returns

Type	Description
StdBELista

Edita(String, String)

Edita a informação associado a um RHPProcessoDividas

Declaration

RhpBEProcessoDivida Edita(string Funcionario, string Referencia)

Parameters

Type	Name	Description
System.String	Funcionario	Código do Funcionário
System.String	Referencia	Referência do processo de dívida

Returns

Type	Description
RhpBEProcessoDivida

EditaID(String)

Edita a informação associado a um RHPProcessoDividas pelo identificador

Declaration

RhpBEProcessoDivida EditaID(string ID)

Parameters

Type	Name	Description
System.String	ID	Identificador do processo de divida

Returns

Type	Description
RhpBEProcessoDivida

Existe(String, String)

Verifica se o RHPProcessoDividas existe na base de dados

Declaration

bool Existe(string Funcionario, string Referencia)

Parameters

Type	Name	Description
System.String	Funcionario	Código do Funcionário
System.String	Referencia	Referência do processo de dívida

Returns

Type	Description
System.Boolean

ExisteID(String)

Verifica pelo identificador se o RHPProcessoDividas existe na base de dados

Declaration

bool ExisteID(string ID)

Parameters

Type	Name	Description
System.String	ID	Identificador do processo de divida

Returns

Type	Description
System.Boolean

ListaProcessosDivida(String, RhpBETipos.EnuEstadoProcessoDivida)

Devolve lista de processos de divida para um estado

Declaration

RhpBEProcessosDivida ListaProcessosDivida(string Funcionario, RhpBETipos.EnuEstadoProcessoDivida Estado)

Parameters

Type	Name	Description
System.String	Funcionario	Código do funcionário
RhpBETipos.EnuEstadoProcessoDivida	Estado	Estado dos processos de divida a devolver

Returns

Type	Description
RhpBEProcessosDivida

Remove(String, String)

Remove toda a informação associada a um RHPProcessoDividas

Declaration

void Remove(string Funcionario, string Referencia)

Parameters

Type	Name	Description
System.String	Funcionario	Código do Funcionário
System.String	Referencia	Referência do processo de dívida

RemoveID(String)

Remove toda a informação associada a um RHPProcessoDividas pelo identificador

Declaration

void RemoveID(string ID)

Parameters

Type	Name	Description
System.String	ID	Identificador do processo de divida

ValidaActualizacao(RhpBEProcessoDivida, ref String)

Efectua a validação de actualização dos dados de um registo.

Declaration

bool ValidaActualizacao(RhpBEProcessoDivida ProcessoDivida, ref string ErroValidacao)

Parameters

Type	Name	Description
RhpBEProcessoDivida	ProcessoDivida	Objecto contendo os novos valores a actualizar.
System.String	ErroValidacao	Recebe a descrição de eventuais erros detectados.

Returns

Type	Description
System.Boolean

ValidaRemocao(String, String, ref String)

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

Declaration

bool ValidaRemocao(string Funcionario, string Referencia, ref string ErroValidacao)

Parameters

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

Returns

Type	Description
System.Boolean

ValidaRemocaoID(String, ref String)

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

Declaration

bool ValidaRemocaoID(string ID, ref string ErroValidacao)

Parameters

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

Returns

Type	Description
System.Boolean