Interface IOrcBSTipoModOrc

Motor dos tipos de modificação orçamental.

Namespace: IOrcBS100

Assembly: IOrcBS100.dll

Syntax

[ComVisible(true)]
[Guid("E62AE024-174E-44CB-B591-4789B91195FB")]
public interface IOrcBSTipoModOrc

Methods

Actualiza(OrcBETipoModOrc, String)

Procedimento para actualização.

Declaration

void Actualiza(OrcBETipoModOrc BETipoModOrc, string Avisos = "")

Parameters

Type	Name	Description
OrcBETipoModOrc	BETipoModOrc	Objecto contendo a informação actualizada do tipo modificação orçamental.
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 TipoMod, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	TipoMod	Identificador do tipo modificação orçamental.
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 TipoMod, StdBECampos Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	TipoMod	Identificador do tipo modificação orçamental.
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.

DaDescricao(Int32, String)

Devolve a descrição associada ao tipo de modificação orçamental.

Declaration

string DaDescricao(int Ano, string TipoMod)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	TipoMod	Identificador do tipo modificação orçamental.

Returns

Type	Description
System.String	Descrição do tipo de modificação orçamental.

DaValorAtributo(Int32, String, String)

Devolve o valor de um atributo.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	TipoMod	Identificador do tipo modificaçã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(Int32, String, Object[])

Devolve o valor de um conjunto de atributos.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	TipoMod	Identificador do tipo modificaçã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(Int32, String)

Edição de um tipo de modificação orçamental.

Declaration

OrcBETipoModOrc Edita(int Ano, string TipoMod)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	TipoMod	Identificador do tipo modificação orçamental.

Returns

Type	Description
OrcBETipoModOrc	Objecto com a informação do tipo de modificação orçamental.

Existe(Int32, String)

Verifica se já existe o tipo de modificação orçamental.

Declaration

bool Existe(int Ano, string TipoMod)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	TipoMod	Identificador do tipo modificação orçamental.

Returns

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

lstTipoModOrc(Int32)

Listagem dos tipos de modificação orçamental.

Declaration

StdBELista lstTipoModOrc(int Ano)

Parameters

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

Returns

Type	Description
StdBELista	Lista dos tipos de modificação orçamental

Remove(Int32, String)

Procedimento para remoção de tipos de modificações orçamentais. Parte do príncipio que as validações já foram efectuadas.

Declaration

void Remove(int Ano, string TipoMod)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	TipoMod	Identificador do tipo modificação orçamental.

ValidaActualizacao(OrcBETipoModOrc, ref String)

Efectua a validação da informação do tipo modificação orçamental.

Declaration

bool ValidaActualizacao(OrcBETipoModOrc BETipoModOrc, ref string ErroValidacao)

Parameters

Type	Name	Description
OrcBETipoModOrc	BETipoModOrc	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(Int32, String, ref String)

Efectua as validações necessárias à remoção do tipo modificação orçamental.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	TipoMod	Identificador do tipo modificação orçamental.
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