Interface IOrcBSOrcamentosDimensoes

Motor dos orçamentos por dimensão

Namespace: IOrcBS100

Assembly: IOrcBS100.dll

Syntax

[ComVisible(true)]
[Guid("A8277C18-204C-44B4-B31D-BD954A104B5E")]
public interface IOrcBSOrcamentosDimensoes

Methods

Actualiza(OrcBEOrcamentoDimensao, String)

Procedimento para actualização do orçamento de uma dimensão.

Declaration

void Actualiza(OrcBEOrcamentoDimensao objBEOrcamento, string Avisos = "")

Parameters

Type	Name	Description
OrcBEOrcamentoDimensao	objBEOrcamento	Objecto contendo a informação actualizada do orçamento da dimensão.
System.String	Avisos	Notificação devolvida pelo processo de actualização.

ActualizaValorAtributo(String, String[], String[], String, Object)

Actualiza o valor de um atributo.

Declaration

void ActualizaValorAtributo(string Orcamento, string[] Dimensoes, string[] Codigos, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	Orcamento	Identificador do orçamento de dimensões.
System.String[]	Dimensoes
System.String[]	Codigos
System.String	Atributo	Nome do atributo cujo valor será actualizado.
System.Object	Valor	Valor do atributo que será actualizado.

ActualizaValorAtributos(String, String[], String[], StdBECampos)

Actualiza os valores respectivos de um conjunto de atributos.

Declaration

void ActualizaValorAtributos(string Orcamento, string[] Dimensoes, string[] Codigos, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	Orcamento	Identificador do orçamento de dimensões.
System.String[]	Dimensoes	Identificador da dimensão.
System.String[]	Codigos	Identificador do código de dimensões.
StdBECampos	Atributos	Identifica os atributos e os respectivos valores a actualizar.

DaDefCamposUtil()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

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

DaTotalOrcamento(String, String, String[], String[], Int32, Int32, Int32)

Retorna o valor total do orçamento

Declaration

decimal DaTotalOrcamento(string Orcamento, string DespRec, string[] Dimensoes, string[] CodigosDim, int NumAltActual = 0, int MesInicial = 1, int MesFinal = 12)

Parameters

Type	Name	Description
System.String	Orcamento	Identificador do orçamento.
System.String	DespRec	Identificador da Despesa ou Receita.
System.String[]	Dimensoes	Identificador das dimensões do orçamento.
System.String[]	CodigosDim	Código das dimensões do orçamento.
System.Int32	NumAltActual	Nº alternativo actual.
System.Int32	MesInicial	Mês inicial para o calculo.
System.Int32	MesFinal	Mês final para o calculo.

Returns

Type	Description
System.Decimal	Valor total do orçamento

DaValorAtributo(String, String[], String[], String)

Devolve o valor de um atributo.

Declaration

dynamic DaValorAtributo(string Orcamento, string[] Dimensoes, string[] Codigos, string Atributo)

Parameters

Type	Name	Description
System.String	Orcamento	Identificador do orçamento de dimensões.
System.String[]	Dimensoes	Identificador da dimensão.
System.String[]	Codigos	Identificador do código de dimensões.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

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

DaValorAtributos(String, String[], String[], Object[])

Devolve o valor de um conjunto de atributos.

Declaration

StdBECampos DaValorAtributos(string Orcamento, string[] Dimensoes, string[] Codigos, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.String	Orcamento	Identificador do orçamento de dimensões.
System.String[]	Dimensoes	Identificador da dimensão.
System.String[]	Codigos	Identificador do código de dimensões.
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

DaValorMoeda(String)

Devolve a moeda de determinado orçamento.

Declaration

string DaValorMoeda(string Orcamento)

Parameters

Type	Name	Description
System.String	Orcamento	Chave do orçamento

Returns

Type	Description
System.String	Moeda de determinado orçamento

Edita(String, String[], String[])

Edição de um orçamento de dimensões.

Declaration

OrcBEOrcamentoDimensao Edita(string Orcamento, string[] Dimensoes, string[] Codigos)

Parameters

Type	Name	Description
System.String	Orcamento	Identificador do orçamento de dimensões.
System.String[]	Dimensoes	Identificador da dimensão.
System.String[]	Codigos	Identificador do código de dimensões.

Returns

Type	Description
OrcBEOrcamentoDimensao	Objecto com a informação do orçamento atualizada.

Existe(String, String[], String[])

Verifica se já existe orçamento para a dimensão definida.

Declaration

bool Existe(string Orcamento, string[] Dimensoes, string[] Codigos)

Parameters

Type	Name	Description
System.String	Orcamento	Identificador do orçamento de dimensões.
System.String[]	Dimensoes	Identificador da dimensão.
System.String[]	Codigos	Identificador do código de dimensões.

Returns

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

lstOrcamento(String)

Listagem de orçamento de dimensões

Declaration

StdBELista lstOrcamento(string Orcamento)

Parameters

Type	Name	Description
System.String	Orcamento	Identificador do orçamento de dimensões.

Returns

Type	Description
StdBELista	Lista de orçamento de dimensões

Remove(String, String[], String[])

Procedimento para remoção de orçamento de dimensões. Parte do princípio que as validações já foram efectuadas através do metódo ValidaRemocao(String, ref String).

Declaration

void Remove(string Orcamento, string[] Dimensoes, string[] Codigos)

Parameters

Type	Name	Description
System.String	Orcamento	Identificador do orçamento de dimensões.
System.String[]	Dimensoes	Identificador da dimensão.
System.String[]	Codigos	Identificador do código de dimensões.

RemoveOrcamento(String)

Procedimento para remoção de orçamentos de dimensões.

Declaration

void RemoveOrcamento(string Orcamento)

Parameters

Type	Name	Description
System.String	Orcamento	Identificador do orçamento.

ValidaActualizacao(OrcBEOrcamentoDimensao, String)

Efectua a validação da informação do orçamento de dimensões.

Declaration

bool ValidaActualizacao(OrcBEOrcamentoDimensao BEOrcamentoCBL, string ErroValidacao)

Parameters

Type	Name	Description
OrcBEOrcamentoDimensao	BEOrcamentoCBL	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)

Efectua as validações necessárias à remoção de orçamentos de dimensões.

Declaration

bool ValidaRemocao(string Orcamento, ref string ErroValidacao)

Parameters

Type	Name	Description
System.String	Orcamento	Identificador do orçamento de dimensões.
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