Interface IOrcBSPlanoRubricas

Motor do plano de rúbricas

Namespace: IOrcBS100

Assembly: IOrcBS100.dll

Syntax

[ComVisible(true)]
[Guid("0400E4BA-7939-42C0-A5EB-8DEC9607A3FD")]
public interface IOrcBSPlanoRubricas

Methods

Actualiza(ref OrcBERubrica, String)

Actualiza o plano de rúbricas na base de dados

Declaration

void Actualiza(ref OrcBERubrica BERubrica, string strAvisos = "")

Parameters

Type	Name	Description
OrcBERubrica	BERubrica	Objecto que identifica o plano de rúbricas 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 plano de rúbricas

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Rubrica	Código da rubrica
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 plano de rúbricas

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Rubrica	Código da Rubrica
StdBECampos	Atributos	Atributos e 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.

DaValorAtributo(Int32, String, String)

Devolve o valor de um atributo do plano de rúbricas

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Rubrica	Código da rubrica
System.String	Atributo	Nome do atributo cujo valor se pretende obter

Returns

Type	Description
System.Object

DaValorAtributoLock(Int32, String, String)

Devolve o valor de um determinado atributo do plano de rúbricas com bloqueio

Declaration

dynamic DaValorAtributoLock(int Ano, string Rubrica, string Atributo)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Rubrica	Rubrica
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 plano de rúbricas

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Rubrica	Código da Rubrica
System.Object[]	Atributos	Atributos para os quais se pretende devolver os valores

Returns

Type	Description
StdBECampos

DaValorAtributosLock(Int32, String, Object[])

Devolve os valores de um conjunto de atributos do plano de rúbricas com bloquei

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Rubrica	Código da Rubrica
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 plano de rúbricas

Declaration

OrcBERubrica Edita(int Ano, string Rubrica)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Rubrica	Código da rubrica

Returns

Type	Description
OrcBERubrica	Objecto com informação da rúbrica atualizada.

Existe(Int32, String)

Verifica se a rubrica existe no plano de rúbricas

Declaration

bool Existe(int Ano, string Rubrica)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Rubrica	Código da rubrica

Returns

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

ExisteRubricaAnterior(Int32, ref String)

Verifica se existe uma rúbrica agregadora associada a esta rubrica

Declaration

bool ExisteRubricaAnterior(int Ano, ref string Rubrica)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Rubrica	Código da rubrica

Returns

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

Remove(Int32, String)

Remove a rubrica do plano de rúbricas

Declaration

void Remove(int Ano, string Rubrica)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Rubrica	Código da rubrica

RubricaAgregadora(Int32, String)

Verifica se a rubrica indicada é agregadora e tem rubricas de movimento associadas

Declaration

bool RubricaAgregadora(int Ano, string Rubrica)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Rubrica	Código da rubrica

Returns

Type	Description
System.Boolean	true em caso afirmativo, false caso contrário

RubricaAssociadaAoPlanoEconomico(Int32, String)

Verifica se a rubrica se encontra associada a um plano económico

Declaration

bool RubricaAssociadaAoPlanoEconomico(int Ano, string Rubrica)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Rubrica	Código da rubrica

Returns

Type	Description
System.Boolean	true em caso afirmativo, false caso contrário

UltimaRubricaAgregadora(Int32, String)

Verifica se a rubrica indicada é agregadora, tem rubricas de movimento associadas e não tem uma rubrica "mãe"

Declaration

bool UltimaRubricaAgregadora(int Ano, string Rubrica)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Rubrica	Código da rubrica

Returns

Type	Description
System.Boolean	true em caso afirmativo, false caso contrário

ValidaActualizacao(OrcBERubrica, ref String)

Efectua as validações necessárias à actualização de uma rubrica do plano de rúbricas

Declaration

bool ValidaActualizacao(OrcBERubrica BERubrica, ref string ErroValidacao)

Parameters

Type	Name	Description
OrcBERubrica	BERubrica	Objecto que identifica o plano de rúbricas 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 de uma rubrica do plano de rúbricas

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Rubrica	Código da rubrica
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