Interface IOrcBSPlanoEconomico

Motor do plano económico

Namespace: IOrcBS100

Assembly: IOrcBS100.dll

Syntax

[ComVisible(true)]
[Guid("81D810ED-7BEC-4E62-A3A8-A71D75679F7E")]
public interface IOrcBSPlanoEconomico

Methods

Actualiza(ref OrcBEEconomica, String)

Procedimento para actualização da classificação económica.

Declaration

void Actualiza(ref OrcBEEconomica BEEconomica, string Avisos = "")

Parameters

Type	Name	Description
OrcBEEconomica	BEEconomica	Objecto contendo a informação actualizada da classificação económica.
System.String	Avisos	Notificação devolvida pelo processo de actualização.

ActualizaValorAtributo(Int32, String, String, Object)

Actualiza o valor de um atributo.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassEcon	Classificação económica.
System.String	Atributo	Nome do atributo cujo valor será actualizado.
System.Object	Valor	Valor do atributo que será actualizado.

ActualizaValorAtributos(Int32, String, StdBECampos)

Actualiza os valores respectivos de um conjunto de atributos.

Declaration

void ActualizaValorAtributos(int Ano, string StrChave, StdBECampos Atributos)

Parameters

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

ContaAnterior(Int32, ref String)

Devolve a classificação económica anterior à classificação passada por parâmetro.

Declaration

bool ContaAnterior(int Ano, ref string ClassEcon)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassEcon	Classificação económica.

Returns

Type	Description
System.Boolean	Classificação económica anterior à classificação passada por parâmetro.

DaContaInferior(Int32, String)

Devolve a classificação económica de nível inferior à classificação passada por parâmetro.

Declaration

string DaContaInferior(int Ano, string ClassEcon)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassEcon	Classificação económica.

Returns

Type	Description
System.String	Classificação económica de nível inferior à classificação passada por parâmetro.

DaDefCamposUtil()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

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

DaDescricao(Int32, String)

Devolve a descrição associada à classificação económica.

Declaration

string DaDescricao(int Ano, string ClassEcon)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassEcon	Classificação económica.

Returns

Type	Description
System.String	Descrição associada à classificação económica.

DaValorAtributo(Int32, String, String)

Devolve o valor de um atributo.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassEcon	Classificação económica.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

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

DaValorAtributoLock(Int32, String, String)

Devolve o valor de um atributo, respeitando os locks da base de dados.

Declaration

dynamic DaValorAtributoLock(int Ano, string ClassEcon, string Atributo)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassEcon	Classificação económica.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

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

DaValorAtributos(Int32, String, Object[])

Devolve o valor de um conjunto de atributos.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassEcon	Classificação económica.
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

DaValorAtributosLock(Int32, String, String[])

Devolve o valor de um conjunto de atributos, respeitando os locks da base de dados.

Declaration

StdBECampos DaValorAtributosLock(int Ano, string ClassEcon, string[] Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassEcon	Classificação económica.
System.String[]	Atributos	Conjunto de atributos dos quais se pretende devolver o valor.

Returns

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

DevolveContasEconomica(Int32, String)

Devolve as contas associadas à classificação económica

Declaration

string DevolveContasEconomica(int Ano, string ClassEcon)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassEcon	Classificação económica.

Returns

Type	Description
System.String	Lista de contas associadas à classificação económica

Edita(Int32, String)

Edição de uma classificação económica.

Declaration

OrcBEEconomica Edita(int Ano, string ClassEcon)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassEcon	Classificação económica.

Returns

Type	Description
OrcBEEconomica	Objeto com a informação da classificação económica atualizada.

Existe(Int32, String)

Verifica se já existe a classificação económica.

Declaration

bool Existe(int Ano, string ClassEcon)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassEcon	Classificação económica.

Returns

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

Existe(Int32, String, ref String)

Verifica se já existe a classificação económica.

Declaration

bool Existe(int Ano, string ClassEcon, ref string TipoConta)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassEcon	Classificação económica.
System.String	TipoConta	Tipo de conta

Returns

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

ListaEconomicasOrcamentadasSemRubrica(Int32)

Devolve uma lista com as classificações económicas sem rubrica associada

Declaration

StdBELista ListaEconomicasOrcamentadasSemRubrica(int Ano)

Parameters

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

Returns

Type	Description
StdBELista	Lista com as classificações económicas sem rubrica associada

lstPlanoEconomico(Int32)

Listagem das classificações económicas.

Declaration

StdBELista lstPlanoEconomico(int Ano)

Parameters

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

Returns

Type	Description
StdBELista	Lista das classificações económicas.

Remove(Int32, String)

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

Declaration

void Remove(int Ano, string ClassEcon)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassEcon	Classificação económica.

ValidaActualizacao(OrcBEEconomica, ref String)

Efectua a validação da informação da classificação económica.

Declaration

bool ValidaActualizacao(OrcBEEconomica BEEconomica, ref string ErroValidacao)

Parameters

Type	Name	Description
OrcBEEconomica	BEEconomica	Objecto contendo a informação actualizada da classificação económica.
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

ValidaContasEconomica(Int32, String, String)

Valida se a conta é permitida para a classificação económica

Declaration

bool ValidaContasEconomica(int Ano, string ClassEcon, string Conta)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassEcon	Classificação económica.
System.String	Conta	Identificador da conta a validar.

Returns

Type	Description
System.Boolean	true em caso afirmativo, false caso contrário

ValidaRemocao(Int32, String, ref String)

Efectua as validações necessárias à remoção da classificação económica.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassEcon	Classificação económica.
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