Interface IOrcBSFundosDisponiveis

Motor dos fundos disponíveis.

Namespace: IOrcBS100

Assembly: IOrcBS100.dll

Syntax

[ComVisible(true)]
[Guid("93CB307E-0B0D-4F45-9DA2-31450D1C61B7")]
public interface IOrcBSFundosDisponiveis

Methods

Actualiza(OrcBEFundoDisponivel)

Procedimento para criação ou atualização de um fundo disponível. Parte do príncipio que as validações já foram efectuadas através do método ValidaActualizacao(OrcBEFundoDisponivel, ref String)

Declaration

void Actualiza(OrcBEFundoDisponivel BEFundoDisponivel)

Parameters

Type	Name	Description
OrcBEFundoDisponivel	BEFundoDisponivel	Objecto contendo a informação actualizada do fundo disponível.

Actualiza(OrcBEFundoDisponivel, ref String)

Procedimento para criação ou atualização de um fundo disponível.

Declaration

void Actualiza(OrcBEFundoDisponivel BEFundoDisponivel, ref string Avisos)

Parameters

Type	Name	Description
OrcBEFundoDisponivel	BEFundoDisponivel	Objecto contendo a informação actualizada do fundo disponível.
System.String	Avisos	Recebe a descrição de eventuais avisos na gravação.

ActualizaValorAtributo(Int32, Int32, String, Object)

Actualiza o valor de um atributo.

Declaration

void ActualizaValorAtributo(int Ano, int Periodo, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Periodo	Período
System.String	Atributo	Nome do atributo cujo valor será actualizado.
System.Object	Valor	Valor do atributo que será atualizado.

ActualizaValorAtributos(Int32, Int32, StdBECampos)

Actualiza os valores respectivos de um conjunto de atributos.

Declaration

void ActualizaValorAtributos(int Ano, int Periodo, StdBECampos Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Periodo	Período
StdBECampos	Atributos	Identifica os atributos e os respectivos valores a actualizar.

AnulaReporteFundoDisponivel(OrcBEFundoDisponivel, ref String, Boolean, Boolean)

Procedimento para anulação do reporte de fundos disponíveis. Parte do príncipio que as validações já foram efectuadas através do método ValidaAnulacaoReporte

Declaration

void AnulaReporteFundoDisponivel(OrcBEFundoDisponivel BEFundoDisponivel, ref string ErroValidacao, bool blnContinuar, bool Confirmacao = false)

Parameters

Type	Name	Description
OrcBEFundoDisponivel	BEFundoDisponivel	Objecto contendo a informação actualizada do fundo disponível.
System.String	ErroValidacao	Recebe a descrição de eventuais erros detetados.
System.Boolean	blnContinuar
System.Boolean	Confirmacao	Indica se o utilizador recebe pedido de confirmação.

DaDefCamposUtil()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

Type	Description
StdBEDefCamposUtil	Definições dos campos do utilizador.

DaTotalAntecipadoPeriodo(Int32, Int32, String, Int32)

Procedimento para cálculo do valor total antecipado de um determinado período

Declaration

double DaTotalAntecipadoPeriodo(int Ano, int Periodo, string Item, int PeriodoAntecipado)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Periodo	Período
System.String	Item	Item para cálculo
System.Int32	PeriodoAntecipado	Período antecipado

Returns

Type	Description
System.Double	Valor total antecipado de um determinado período

DaUltimoPeriodoProcessado(Int32)

Devolve o último período processado.

Declaration

int DaUltimoPeriodoProcessado(int Ano)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.

Returns

Type	Description
System.Int32	Último período processado para o ano passado por parâmetro.

DaUltimoPeriodoReportado(Int32)

Devolve o último período reportado.

Declaration

int DaUltimoPeriodoReportado(int Ano)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.

Returns

Type	Description
System.Int32	Último período reportado para o ano passado por parâmetro.

DaValorAtributo(Int32, Int32, String)

Devolve o valor de um atributo.

Declaration

dynamic DaValorAtributo(int Ano, int Periodo, string Atributo)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Periodo	Período
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

Type	Description
System.Object	Valor do atributo passado por parâmetro

DaValorAtributos(Int32, Int32, Object[])

Devolve o valor de um conjunto de atributos.

Declaration

StdBECampos DaValorAtributos(int Ano, int Periodo, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Periodo	Período
System.Object[]	Atributos	Conjunto de atributos dos quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos	Lista de atributos mapeados em objetos do tipo StdBECampo

Edita(Int32, Int32)

Edição do processamento de um fundo disponível.

Declaration

OrcBEFundoDisponivel Edita(int Ano, int Periodo)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Periodo	Período

Returns

Type	Description
OrcBEFundoDisponivel	Objeto contendo a informação actualizada do fundo disponível.

Existe(Int32, Int32)

Verifica se já existe processamento de fundos disponíveis.

Declaration

bool Existe(int Ano, int Periodo)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Periodo	Período

Returns

Type	Description
System.Boolean	true se existe, false caso contrário

ExistemMovimentos(Int32, Int32)

Valida se existem movimentos para reporte do fundo disponível.

Declaration

bool ExistemMovimentos(int Ano, int Periodo)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Periodo	Período

Returns

Type	Description
System.Boolean	true se existe, false caso contrário

ProcessaFundoDisponivel(Int32, Int32)

Procedimento para processamento de fundos disponíveis.

Declaration

OrcBEFundoDisponivel ProcessaFundoDisponivel(int Ano, int Periodo)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Periodo	Período

Returns

Type	Description
OrcBEFundoDisponivel	Objecto contendo a informação processada do fundo disponível.

Remove(Int32, Int32)

Procedimento para remoção do processamento de fundos disponíveis. Parte do príncipio que as validações já foram efectuadas através do método ValidaRemocao(Int32, Int32, ref String)

Declaration

void Remove(int Ano, int Periodo)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Periodo	Período

ReportaFundoDisponivel(OrcBEFundoDisponivel)

Procedimento para reporte de fundos disponíveis.

Declaration

void ReportaFundoDisponivel(OrcBEFundoDisponivel BEFundoDisponivel)

Parameters

Type	Name	Description
OrcBEFundoDisponivel	BEFundoDisponivel	Objecto contendo a informação actualizada do fundo disponível.

ReportaFundoDisponivel(OrcBEFundoDisponivel, ref String)

Procedimento para reporte de fundos disponíveis.

Declaration

void ReportaFundoDisponivel(OrcBEFundoDisponivel BEFundoDisponivel, ref string Avisos)

Parameters

Type	Name	Description
OrcBEFundoDisponivel	BEFundoDisponivel	Objecto contendo a informação actualizada do fundo disponível.
System.String	Avisos	Recebe a descrição de eventuais avisos na gravação.

ValidaActualizacao(OrcBEFundoDisponivel, ref String)

Efectua a validação da informação de um fundo disponível.

Declaration

bool ValidaActualizacao(OrcBEFundoDisponivel BEFundoDisponivel, ref string ErroValidacao)

Parameters

Type	Name	Description
OrcBEFundoDisponivel	BEFundoDisponivel	Objecto contendo a informação actualizada do fundo disponível.
System.String	ErroValidacao	Recebe a descrição de eventuais erros detetados.

Returns

Type	Description
System.Boolean	true caso a validação tenha sucedido, false caso contrário

ValidaAnulacaoReporte(Int32, Int32, ref String, ref Boolean, Boolean)

Efectua a validação da anulação do reporte de um fundo disponível.

Declaration

bool ValidaAnulacaoReporte(int Ano, int Periodo, ref string ErroValidacao, ref bool blnPergContinuar, bool validaMovimentos = false)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Periodo	Período
System.String	ErroValidacao	Recebe a descrição de eventuais erros detetados.
System.Boolean	blnPergContinuar
System.Boolean	validaMovimentos

Returns

Type	Description
System.Boolean	true caso a validação tenha sucedido, false caso contrário

ValidaRemocao(Int32, Int32, ref String)

Efectua as validações necessárias à remoção de um fundo disponível.

Declaration

bool ValidaRemocao(int Ano, int Periodo, ref string ErroValidacao)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Periodo	Período
System.String	ErroValidacao	Recebe a descrição de eventuais erros detetados.

Returns

Type	Description
System.Boolean	true caso a validação tenha sucedido, false caso contrário