Interface IOrcBSPlanoOrganico

Motor do plano orgânico

Namespace: IOrcBS100

Assembly: IOrcBS100.dll

Syntax

[ComVisible(true)]
[Guid("682AC5EB-2634-4DEA-9D5B-43AC235E83EB")]
public interface IOrcBSPlanoOrganico

Methods

Actualiza(ref OrcBEOrganica, String)

Procedimento para actualização da classificação orgânica.

Declaration

void Actualiza(ref OrcBEOrganica BEOrganica, string Avisos = "")

Parameters

Type	Name	Description
OrcBEOrganica	BEOrganica	Objecto contendo a informação actualizada da classificação orgânica.
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 ClassOrgan, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassOrgan	Classificação orgânica.
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 ClassOrgan, StdBECampos Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassOrgan	Classificação orgânica.
StdBECampos	Atributos	Identifica os atributos e os respectivos valores a actualizar.

ContaAnterior(Int32, ref String)

Devolve a classificação orgânica anterior à classificação passada por parâmetro.

Declaration

bool ContaAnterior(int Ano, ref string ClassOrgan)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassOrgan	Classificação orgânica.

Returns

Type	Description
System.Boolean	Classificação orgânica anterior à classificação passada por parâmetro.

DaAgregadoraInferiorComNivelValidacao(Int32, String)

Devolve a primeira classificação inferior com nível de validação em contas integradoras

Declaration

string DaAgregadoraInferiorComNivelValidacao(int Ano, string ClassificacaoOrganica)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassificacaoOrganica	Identificador da classificação orgânica a validar.

Returns

Type	Description
System.String	Primeira classificação orgânica inferior com nível de validação em contas integradoras

DaAgregadoraSuperiorComNivelValidacao(Int32, String)

Devolve a primeira classificação superior com nível de validação em contas integradoras com nível superior

Declaration

string DaAgregadoraSuperiorComNivelValidacao(int Ano, string ClassificacaoOrganica)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassificacaoOrganica	Identificador da classificação orgânica a validar.

Returns

Type	Description
System.String	Primeira classificação superior com nível de validação em contas integradoras com nível superior

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 à classificação orgânica.

Declaration

string DaDescricao(int Ano, string ClassOrgan)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassOrgan	Classificação orgânica.

Returns

Type	Description
System.String	Descrição associada à classificação orgânica.

DaValorAtributo(Int32, String, String)

Devolve o valor de um atributo.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassOrgan	Classificação orgânica.
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 ClassOrg, string Atributo)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassOrg	Código da classificação orgânica
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 ClassOrgan, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassOrgan	Classificação orgânica.
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 ClassOrg, string[] Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassOrg	Código da classificação orgânica
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 classificação orgânica.

Declaration

OrcBEOrganica Edita(int Ano, string ClassOrgan)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassOrgan	Classificação orgânica.

Returns

Type	Description
OrcBEOrganica	Objecto com a informação da classificação orgânica atualizada.

Existe(Int32, String)

Verifica se já existe a classificação orgânica.

Declaration

bool Existe(int Ano, string ClassOrgan)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassOrgan	Classificação orgânica.

Returns

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

Existe(Int32, String, ref String)

Verifica se já existe a classificação orgânica.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassOrgan	Classificação orgânica.
System.String	TipoConta	Tipo de conta

Returns

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

ExisteAgregadoraInferiorComNivelValidacao(Int32, String)

Indica se existe alguma classificação orgânica com nível de validação em contas integradoras com nível inferior

Declaration

bool ExisteAgregadoraInferiorComNivelValidacao(int Ano, string ClassificacaoOrganica)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassificacaoOrganica	Identificador da classificação orgânica a validar.

Returns

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

ExisteAgregadoraSuperiorComNivelValidacao(Int32, String)

Indica se existe alguma classificação orgânica com nível de validação em contas integradoras com nível superior

Declaration

bool ExisteAgregadoraSuperiorComNivelValidacao(int Ano, string ClassificacaoOrganica)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassificacaoOrganica	Identificador da classificação orgânica a validar.

Returns

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

ExistemAgregadorasComNivelValidacao(Int32)

Indica se existe alguma classificação orgânica com nível de validação em contas integradoras

Declaration

bool ExistemAgregadorasComNivelValidacao(int Ano)

Parameters

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

Returns

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

lstPlanoOrganico(Int32)

Listagem das classificações orgânicas.

Declaration

StdBELista lstPlanoOrganico(int Ano)

Parameters

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

Returns

Type	Description
StdBELista	Lista das classificações orgânicas.

Remove(Int32, String)

Procedimento para remoção de classificações orgânicas. 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 ClassOrgan)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassOrgan	Classificação orgânica.

ValidaActualizacao(OrcBEOrganica, ref String)

Efectua a validação da informação da classificação orgânica.

Declaration

bool ValidaActualizacao(OrcBEOrganica BEOrganica, ref string ErroValidacao)

Parameters

Type	Name	Description
OrcBEOrganica	BEOrganica	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 da classificação orgânica.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassOrgan	Classificação orgânica.
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