Interface IOrcBSProgramaMedida

Motor dos programas/medidas

Namespace: IOrcBS100

Assembly: IOrcBS100.dll

Syntax

[ComVisible(true)]
[Guid("11475F81-5F1C-4110-8710-DCA6BE8CE74C")]
public interface IOrcBSProgramaMedida

Methods

Actualiza(OrcBEProgramaMedida, String)

Procedimento para actualização de um programa/medida.

Declaration

void Actualiza(OrcBEProgramaMedida BEProgramaMedida, string Avisos = "")

Parameters

Type	Name	Description
OrcBEProgramaMedida	BEProgramaMedida	Objecto com a informação do programa/medida atualizada.
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 Programa, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Programa	Identificador do Programa/Medida.
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 Programa, StdBECampos Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Programa	Identificador do Programa/Medida.
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 Programa/Medida.

Declaration

string DaDescricao(int Ano, string Programa)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Programa	Identificador do Programa/Medida.

Returns

Type	Description
System.String	Descrição associada ao Programa/Medida.

DaValorAtributo(Int32, String, String)

Devolve o valor de um atributo.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Programa	Identificador do Programa/Medida.
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 Programa, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Programa	Identificador do Programa/Medida.
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 umo Programa/Medida.

Declaration

OrcBEProgramaMedida Edita(int Ano, string Programa)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Programa	Identificador do Programa/Medida.

Returns

Type	Description
OrcBEProgramaMedida	Objecto com a informação do programa/medida

Existe(Int32, String)

Verifica se já existe o Programa/Medida.

Declaration

bool Existe(int Ano, string Programa)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Programa	Identificador do Programa/Medida.

Returns

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

lstProgramaMedida(Int32)

Listagem dos Programas/Medidas.

Declaration

StdBELista lstProgramaMedida(int Ano)

Parameters

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

Returns

Type	Description
StdBELista	Lista dos Programas/Medidas

Remove(Int32, String)

Procedimento para remoção do Programa/Medida. Parte do príncipio que as validações já foram efectuadas.

Declaration

void Remove(int Ano, string Programa)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Programa	Identificador do Programa/Medida.

ValidaActualizacao(OrcBEProgramaMedida, ref String)

Efectua a validação da informação do Programa/Medida.

Declaration

bool ValidaActualizacao(OrcBEProgramaMedida BEProgramaMedida, ref string ErroValidacao)

Parameters

Type	Name	Description
OrcBEProgramaMedida	BEProgramaMedida
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 Programa/Medida.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Programa	Identificador do Programa/Medida.
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