Interface IOrcBSDimensoes

Motor das dimensões orçamentais

Namespace: IOrcBS100

Assembly: IOrcBS100.dll

Syntax

[ComVisible(true)]
[Guid("DB890F22-8461-4D82-92B9-3BDEBD570E1D")]
public interface IOrcBSDimensoes

Methods

Actualiza(OrcBEDimensao, String)

Procedimento para atualização de uma dimensão orçamental.

Declaration

void Actualiza(OrcBEDimensao BEDimensao, string Avisos = "")

Parameters

Type	Name	Description
OrcBEDimensao	BEDimensao	Objecto contendo a informação actualizada da dimensão.
System.String	Avisos	Notificação devolvida pelo processo de actualização.

ActualizaValorAtributo(String, String, Object)

Actualiza o valor de um atributo.

Declaration

void ActualizaValorAtributo(string Dimensao, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	Dimensao	Identificador da dimensão orçamental.
System.String	Atributo	Nome do atributo cujo valor será actualizado.
System.Object	Valor	Valor do atributo que será actualizado.

ActualizaValorAtributos(String, StdBECampos)

Actualiza os valores respectivos de um conjunto de atributos.

Declaration

void ActualizaValorAtributos(string StrChave, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	StrChave	Identificador da dimensão orçamental.
StdBECampos	Atributos	Identifica os atributos e os respectivos valores a actualizar.

DaAno(String)

Devolve o ano associado à dimensão orçamental.

Declaration

int DaAno(string Dimensao)

Parameters

Type	Name	Description
System.String	Dimensao	Identificador da dimensão orçamental.

Returns

Type	Description
System.Int32	Ano associado à dimensão orçamental.

DaCodigoDescricao(String, String)

Descrição associada ao códido de dimensão.

Declaration

string DaCodigoDescricao(string Dimensao, string Codigo)

Parameters

Type	Name	Description
System.String	Dimensao	Identificador da dimensão orçamental.
System.String	Codigo	Identificador do código da dimensao.

Returns

Type	Description
System.String

DaDefCamposUtil()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

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

DaDefCamposUtilLinhas()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtilLinhas()

Returns

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

DaDescricao(String)

Devolve a descrição associada à dimensão orçamental.

Declaration

string DaDescricao(string Dimensao)

Parameters

Type	Name	Description
System.String	Dimensao	Identificador da dimensão orçamental.

Returns

Type	Description
System.String	Descrição associada à dimensão orçamental

DaValorAtributo(String, String)

Devolve o valor de um atributo.

Declaration

dynamic DaValorAtributo(string Dimensao, string Atributo)

Parameters

Type	Name	Description
System.String	Dimensao	Identificador da dimensão orçamental.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

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

DaValorAtributos(String, Object[])

Devolve o valor de um conjunto de atributos.

Declaration

StdBECampos DaValorAtributos(string Dimensao, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.String	Dimensao	Identificador da dimensão orçamental.
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(String)

Edição de uma dimensão orçamental.

Declaration

OrcBEDimensao Edita(string Dimensao)

Parameters

Type	Name	Description
System.String	Dimensao	Identificador da dimensão orçamental.

Returns

Type	Description
OrcBEDimensao	Objeto contendo a dimensão orçamental atualizada.

Existe(String)

Verifica se já existe a dimensão orçamental.

Declaration

bool Existe(string Dimensao)

Parameters

Type	Name	Description
System.String	Dimensao	Identificador da dimensão orçamental.

Returns

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

ExisteCodigo(String, String)

Verifica se já existe o código da dimensão orçamental.

Declaration

bool ExisteCodigo(string Dimensao, string Codigo)

Parameters

Type	Name	Description
System.String	Dimensao	Identificador da dimensão orçamental.
System.String	Codigo	Identificador do código da dimensao.

Returns

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

lstDimensoes()

Lista as dimensões orçamentais.

Declaration

StdBELista lstDimensoes()

Returns

Type	Description
StdBELista	Lista das dimensões orçamentais.

lstDimensoesAno(Int32)

Lista as dimensões orçamentais para o ano passado por parâmetro.

Declaration

StdBELista lstDimensoesAno(int Ano)

Parameters

Type	Name	Description
System.Int32	Ano

Returns

Type	Description
StdBELista	Lista das dimensões orçamentais.

Remove(String)

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

Declaration

void Remove(string Dimensao)

Parameters

Type	Name	Description
System.String	Dimensao	Identificador da dimensão orçamental.

ValidaActualizacao(OrcBEDimensao, ref String)

Efectua a validação da informação da dimensão.

Declaration

bool ValidaActualizacao(OrcBEDimensao BEDimensao, ref string ErroValidacao)

Parameters

Type	Name	Description
OrcBEDimensao	BEDimensao	Objecto contendo a informação que se pretende validar.
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

ValidaRemocao(String, ref String, Boolean)

Efectua as validações necessárias à remoção da dimensão.

Declaration

bool ValidaRemocao(string Dimensao, ref string ErroValidacao, bool Codigo = true)

Parameters

Type	Name	Description
System.String	Dimensao	Identificador da dimensão orçamental.
System.String	ErroValidacao	Recebe a descrição de eventuais erros detetados.
System.Boolean	Codigo

Returns

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

ValidaRemocaoCodigo(String, String, ref String)

Efectua as validações necessárias à remoção da dimensão.

Declaration

bool ValidaRemocaoCodigo(string Dimensao, string Codigo, ref string ErroValidacao)

Parameters

Type	Name	Description
System.String	Dimensao	Identificador da dimensão orçamental.
System.String	Codigo	Identificador do código da dimensao.
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