Interface IOrcBSObjectivos

Motor dos objetivos (definição nas GOPs - Grandes opções do plano)

Namespace: IOrcBS100

Assembly: IOrcBS100.dll

Syntax

[ComVisible(true)]
[Guid("845FD5DC-4F28-4395-911E-6391A69CFB0F")]
public interface IOrcBSObjectivos

Methods

Actualiza(OrcBEObjectivo, String)

Actualiza o objetivo na base de dados

Declaration

void Actualiza(OrcBEObjectivo BEObjectivo, string strAvisos = "")

Parameters

Type	Name	Description
OrcBEObjectivo	BEObjectivo	Objecto que identifica o objetivo a actualizar
System.String	strAvisos	Descrição dos avisos que possam surgir durante a actualização

ActualizaValorAtributo(Int32, String, String, Object)

Permite efectuar a actualização de um atributo de um determinado objetivo

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Objectivo	Objectivo
System.String	Atributo	Nome do campo a actualizar
System.Object	Valor	Valor do campo a actualizar

ActualizaValorAtributoID(Int32, String, String, Object)

Permite efectuar a actualização de um atributo de um determinado objetivo

Declaration

void ActualizaValorAtributoID(int Ano, string Objectivo, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Objectivo	Objectivo
System.String	Atributo	Nome do campo a actualizar
System.Object	Valor	Valor do campo a actualizar

ActualizaValorAtributos(Int32, String, StdBECampos)

Permite efectuar a actualização de um conjunto de atributos de um determinado objetivo

Declaration

void ActualizaValorAtributos(int Ano, string Objectivo, StdBECampos Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Objectivo	Objectivo
StdBECampos	Atributos	Atributos e respectivos valores a actualizar

ActualizaValorAtributosID(Int32, String, StdBECampos)

Permite efectuar a actualização de um conjunto de atributos de um determinado objetivo

Declaration

void ActualizaValorAtributosID(int Ano, string Objectivo, StdBECampos Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Objectivo	Objectivo
StdBECampos	Atributos	Atributos e respectivos valores a actualizar

CriaContaRazao(Int32, String)

Cria uma conta razão no plano dos objetivos.

Declaration

void CriaContaRazao(int Ano, string Objetivo)

Parameters

Type	Name	Description
System.Int32	Ano	Ano
System.String	Objetivo	Objetivo

DaDefCamposUtil()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

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

DaValorAtributo(Int32, String, String)

Devolve o valor de um atributo

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Objectivo	Objectivo
System.String	Atributo	Atributo que se pretende obter o valor

Returns

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

DaValorAtributoID(Int32, String, String)

Devolve o valor de um determinado atributo do objetivo

Declaration

dynamic DaValorAtributoID(int Ano, string Objectivo, string Atributo)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Objectivo	Objectivo
System.String	Atributo	Atributo que se pretende obter o valor

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 Objectivo, string Atributo)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Objectivo	Identificador do objetivo
System.String	Atributo	Atributo que se pretende obter o valor

Returns

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

DaValorAtributos(Int32, String, Object[])

Devolve os valores de um conjunto de atributos do objetivo

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Objectivo	Objectivo
System.Object[]	Atributos	Atributos para os quais se pretende devolver os valores

Returns

Type	Description
StdBECampos	Lista de atributos mapeados em objetos do tipo StdBECampo

DaValorAtributosID(Int32, String, Object[])

Devolve os valores de um conjunto de atributos do objetivo

Declaration

StdBECampos DaValorAtributosID(int Ano, string Objectivo, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Objectivo	Objectivo
System.Object[]	Atributos	Atributos para os quais se pretende devolver os valores

Returns

Type	Description
StdBECampos	Lista de atributos mapeados em objetos do tipo StdBECampo

DaValorAtributosLock(Int32, String, Object[])

Devolve os valores de um conjunto de atributos do objetivo

Declaration

StdBECampos DaValorAtributosLock(int Ano, string Objectivo, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Objectivo	Objectivo
System.Object[]	Atributos	Atributos para os quais se pretende devolver os valores

Returns

Type	Description
StdBECampos	Lista de atributos mapeados em objetos do tipo StdBECampo

Edita(Int32, String)

Edita a informação associado a um objetivo

Declaration

OrcBEObjectivo Edita(int Ano, string Objectivo)

Parameters

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

Returns

Type	Description
OrcBEObjectivo	Objecto com a informação do objetivo atualizada.

EditaID(Int32, String)

Edita a informação associado a um objetivo

Declaration

OrcBEObjectivo EditaID(int Ano, string Objectivo)

Parameters

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

Returns

Type	Description
OrcBEObjectivo	Objecto com a informação do objetivo atualizada.

Existe(Int32, String, ref String)

Verifica se o objetivo existe na base de dados

Declaration

bool Existe(int Ano, string Objectivo, ref string TipoConta)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Objectivo	Objectivo
System.String	TipoConta	Tipo de conta

Returns

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

ExisteID(Int32, String, ref String)

Verifica pelo identificador se o objetivo existe na base de dados

Declaration

bool ExisteID(int Ano, string Objectivo, ref string TipoConta)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Objectivo	Objectivo
System.String	TipoConta	Tipo de conta

Returns

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

Remove(Int32, String)

Remove toda a informação associada a um objetivo

Declaration

void Remove(int Ano, string Objectivo)

Parameters

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

RemoveID(Int32, String)

Remove toda a informação associada a um objetivo

Declaration

void RemoveID(int Ano, string Objectivo)

Parameters

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

ValidaActualizacao(OrcBEObjectivo, ref String)

Efectua as validações necessárias à actualização de um objetivo

Declaration

bool ValidaActualizacao(OrcBEObjectivo BEObjectivo, ref string ErroValidacao)

Parameters

Type	Name	Description
OrcBEObjectivo	BEObjectivo	Objecto que identifica o objetivo a validar
System.String	ErroValidacao	Descrição de erro devolvida pela função

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 objetivo

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Objectivo	Objectivo
System.String	ErroValidacao	Descrição de erro devolvida pela função

Returns

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

ValidaRemocaoID(Int32, String, ref String)

Efectua as validações necessárias à remoção do objetivo

Declaration

bool ValidaRemocaoID(int Ano, string Objectivo, ref string ErroValidacao)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Objectivo	Objectivo
System.String	ErroValidacao	Descrição de erro devolvida pela função

Returns

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