Interface IOrcBSActividades

Motor do plano de atividades

Namespace: IOrcBS100

Assembly: IOrcBS100.dll

Syntax

[ComVisible(true)]
[Guid("E8DB861F-528B-49CB-A5A8-53D8F9CB099F")]
public interface IOrcBSActividades

Methods

Actualiza(OrcBEActividade, String)

Procedimento para criação ou atualização de uma atividade.

Declaration

void Actualiza(OrcBEActividade BEActividade, string Avisos = "")

Parameters

Type	Name	Description
OrcBEActividade	BEActividade	Objecto contendo a informação actualizada da Atividade.
System.String	Avisos	Recebe a descrição de eventuais avisos na gravação.

ActualizaValorAtributo(Int32, String, String, Object)

Actualiza o valor de um atributo.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Actividade	Identificador da atividade.
System.String	Atributo	Nome do atributo cujo valor será actualizado.
System.Object	Valor	Valor do atributo que será atualizado.

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	Identificador da atividade.
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 à atividade.

Declaration

string DaDescricao(int Ano, string Actividade)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Actividade	Identificador da Atividade.

Returns

Type	Description
System.String	Descrição da atividade

DaValorAtributo(Int32, String, String)

Devolve o valor de um atributo.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Actividade	Identificador da Atividade.
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 Actividade, string Atributo)

Parameters

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Actividade	Identificador da atividade.
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 Actividade, string[] Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Actividade	Identificador da atividade.
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

Edita(Int32, String)

Edição de uma Atividade.

Declaration

OrcBEActividade Edita(int Ano, string Actividade)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Actividade	Identificador da Atividade.

Returns

Type	Description
OrcBEActividade	Objeto contendo a informação actualizada da Atividade.

Existe(Int32, String)

Verifica se já existe a atividade.

Declaration

bool Existe(int Ano, string Actividade)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Actividade	Identificador da Atividade.

Returns

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

lstActividades()

Lista todas as atividades existentes

Declaration

StdBELista lstActividades()

Returns

Type	Description
StdBELista	Objeto do tipo StdBELista contendo todas as atividades.

lstActividadesAno(Int32)

Lista todas as atividades existentes num determinado ano passado por parâmetro.

Declaration

StdBELista lstActividadesAno(int Ano)

Parameters

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

Returns

Type	Description
StdBELista	Objeto do tipo StdBELista contendo todas as atividades do ano passado por parâmetro.

Remove(Int32, String)

Procedimento para remoção de uma Atividade. 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 Actividade)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Actividade	Identificador da atividade.

ValidaActualizacao(OrcBEActividade, ref String)

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

Declaration

bool ValidaActualizacao(OrcBEActividade Actividade, ref string ErroValidacao)

Parameters

Type	Name	Description
OrcBEActividade	Actividade	Atividade a 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 da atividade.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Actividade	Identificador da atividade.
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.