Interface IOrcBSAlteracoesOrcamento

Motor das alterações orçamentais

Namespace: IOrcBS100

Assembly: IOrcBS100.dll

Syntax

[ComVisible(true)]
[Guid("4170E7B5-B142-4370-B397-FDAFCEA2702D")]
public interface IOrcBSAlteracoesOrcamento

Methods

Actualiza(OrcBEAlteracaoOrcamento, String)

Procedimento para actualização de uma alteração orçamental. Parte do príncipio que as validações já foram efectuadas através do método ValidaActualizacao(OrcBEAlteracaoOrcamento, ref String)

Declaration

void Actualiza(OrcBEAlteracaoOrcamento BEAlteracaoOrcamento, string Avisos = "")

Parameters

Type	Name	Description
OrcBEAlteracaoOrcamento	BEAlteracaoOrcamento	Objecto contendo a informação actualizada da alteração.
System.String	Avisos	Notificação devolvida pelo processo de actualização.

ActualizaAprova(OrcBEAlteracaoOrcamento, CblBEDocumento, String)

Procedimento para aprovação de uma alteração orçamental.

Declaration

void ActualizaAprova(OrcBEAlteracaoOrcamento BEAlteracaoOrcamento, CblBEDocumento objDocumento, string Avisos = "")

Parameters

Type	Name	Description
OrcBEAlteracaoOrcamento	BEAlteracaoOrcamento	Objecto contendo a informação actualizada da alteração.
CblBEDocumento	objDocumento	Objecto contendo a informação actualizada do documentoCBL.
System.String	Avisos	Notificação devolvida pelo processo de aprovação.

ActualizaIntegracaoCBL(OrcBEAltIntegracaoCBL)

Procedimento para actualização da integração com o módulo de contabilidade.

Declaration

void ActualizaIntegracaoCBL(OrcBEAltIntegracaoCBL BEAltIntegracaoCBL)

Parameters

Type	Name	Description
OrcBEAltIntegracaoCBL	BEAltIntegracaoCBL	Objecto contendo a informação actualizada da integração.

ActualizaValorAtributo(Int32, Int32, String, Object)

Actualiza o valor de um atributo.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Alteracao	Identificador da alteração orçamental.
System.String	Atributo	Nome do atributo cujo valor será actualizado.
System.Object	Valor	Valor do atributo que será actualizado.

ActualizaValorAtributos(Int32, Int32, StdBECampos)

Actualiza os valores respectivos de um conjunto de atributos.

Declaration

void ActualizaValorAtributos(int Ano, int Alteracao, StdBECampos Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Alteracao	Identificador da alteração orçamental.
StdBECampos	Atributos	Identifica os atributos e os respectivos valores a actualizar.

CriaDocumentoModificacao(OrcBEAlteracaoOrcamento, String[], Int32, Int32)

Criação de documentos de alteração orçamental por tipo de lançamento

Declaration

PrimaveraOrderedDictionary CriaDocumentoModificacao(OrcBEAlteracaoOrcamento BEAlteracaoOrcamento, string[] Contas, int DiaDoc, int MesDoc)

Parameters

Type	Name	Description
OrcBEAlteracaoOrcamento	BEAlteracaoOrcamento	Objeto de alteração orçamento.
System.String[]	Contas
System.Int32	DiaDoc	Dia do documento.
System.Int32	MesDoc	Mês do documento.

Returns

Type	Description
Primavera.Platform.Collections.PrimaveraOrderedDictionary	Collection de documentos por tipo de lançamento.

DaDefCamposUtil()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

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

DaValorAtributo(Int32, Int32, String)

Devolve o valor de um atributo.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Alteracao	Identificador da alteração orçamental.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

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

DaValorAtributoLock(Int32, Int32, String)

Devolve o valor de um atributo, respeitando os locks da base de dados.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Alteracao	Código da alteração orçamental
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

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

DaValorAtributos(Int32, Int32, Object[])

Devolve o valor de um conjunto de atributos.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Alteracao	Identificador da alteração orçamental.
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, Int32, String[])

Devolve o valor de um conjunto de atributos, respeitando os locks da base de dados.

Declaration

StdBECampos DaValorAtributosLock(int Ano, int Alteracao, string[] Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Alteracao	Identificador da alteração orçamental.
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, Int32)

Edição de uma alteração orçamental.

Declaration

OrcBEAlteracaoOrcamento Edita(int Ano, int Alteracao)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Alteracao	Identificador da alteração orçamental.

Returns

Type	Description
OrcBEAlteracaoOrcamento	Objeto com a alteração orçamental atualizada.

Existe(Int32, Int32)

Verifica se já existe a alteração orçamental.

Declaration

bool Existe(int Ano, int Alteracao)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Alteracao	Identificador da alteração orçamental.

Returns

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

ExisteLinha(Int32, Int32, Boolean, String, String, String, String, String, String)

Verifica se já existe a linha na alteração.

Declaration

bool ExisteLinha(int Ano, int Alteracao, bool IsDespesa, string ClassOrgan, string ClassEcon, string ContaOrc, string FonteFinanc, string Actividade, string ProgMedida)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Alteracao	Identificador da alteração orçamental.
System.Boolean	IsDespesa	Define se a alteração é do orçamento da despesa ou receita.
System.String	ClassOrgan	Classificação orgânica.
System.String	ClassEcon	Classificação económica.
System.String	ContaOrc	Conta orçamental.
System.String	FonteFinanc	Fonte de financiamento.
System.String	Actividade	Atividade
System.String	ProgMedida	Programa/Medida

Returns

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

GetLastNumAltRev(Int32, String)

Função para obter o último número alternativo

Declaration

int GetLastNumAltRev(int Ano, string strAltRev)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	strAltRev	Identificador do número alternativo.

Returns

Type	Description
System.Int32	Último número alternativo

MaxAlteracao(Int32)

Devolve o máximo númerador das alterações orçamentais do ano passado por parâmetro

Declaration

int MaxAlteracao(int Ano)

Parameters

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

Returns

Type	Description
System.Int32	Máximo númerador das alterações orçamentais

Remove(Int32, Int32)

Procedimento para remoção de alterações orçamentais. Parte do príncipio que as validações já foram efectuadas através do método ValidaRemocao(Int32, Int32, ref String)

Declaration

void Remove(int Ano, int Alteracao)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Alteracao	Identificador da alteração orçamental.

RemoveIntegracaoCBL(ref Int32, Int32, String)

Procedimento para remoção da integração contabilística de alterações orçamentais. Parte do príncipio que as validações já foram efectuadas.

Declaration

void RemoveIntegracaoCBL(ref int Ano, int Alteracao, string IdDoc)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Alteracao	Identificador da alteração orçamental.
System.String	IdDoc	Identificador do documento de integração com o módulo de contabilidade.

ValidaActualizacao(OrcBEAlteracaoOrcamento, ref String)

Efectua a validação da informação da alteração orçamental.

Declaration

bool ValidaActualizacao(OrcBEAlteracaoOrcamento AlteracaoOrc, ref string ErroValidacao)

Parameters

Type	Name	Description
OrcBEAlteracaoOrcamento	AlteracaoOrc	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

ValidaClassificacaoEmUso(Int32, String, String, String, String, String, String, String)

Valida se a classificação está em uso em alterações orçamentais

Declaration

bool ValidaClassificacaoEmUso(int Ano, string WBSItem, string ClassOrgan, string ClassEcon, string FonteFinanc, string Actividade, string ProgMedida, string IdProjeto)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	WBSItem	WBSItem (elem. programa de execução do projeto)
System.String	ClassOrgan	Classificação orgânica.
System.String	ClassEcon	Classificação económica.
System.String	FonteFinanc	Fonte de financiamento.
System.String	Actividade	Atividade
System.String	ProgMedida	Programa/Medida
System.String	IdProjeto	Projeto

Returns

Type	Description
System.Boolean	true caso esteja em utilização, false caso contrário

ValidaRemocao(Int32, Int32, ref String)

Efectua as validações necessárias à remoção da alteração orçamental.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.Int32	Alteracao	Identificador da alteração orçamental.
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

ValidateBlockDocIntro(String, String, String, String, String, String, String, String)

Valida se o documento de alteração orçamental está bloqueado

Declaration

string ValidateBlockDocIntro(string TipoLancamento, string Conta, string ClassEcon, string ClassOrgan, string ContaOrc, string FonteFinanc, string Actividade, string ProgMedida)

Parameters

Type	Name	Description
System.String	TipoLancamento	Tipo de lançamento orçamental
System.String	Conta	numero de conta.
System.String	ClassEcon	Identificador da classificação económica.
System.String	ClassOrgan	Identificador da classificação orgânica.
System.String	ContaOrc	Identificador da conta orçamental.
System.String	FonteFinanc	Fonte de financiamento
System.String	Actividade	Atividade
System.String	ProgMedida	Programa/Medida

Returns

Type	Description
System.String

ValidateBlockDocIntroAno(String, String, String, String, String, String, String, String, Int32)

Valida se o documento de alteração orçamental está bloqueado por ano

Declaration

string ValidateBlockDocIntroAno(string TipoLancamento, string Conta, string ClassEcon, string ClassOrgan, string ContaOrc, string FonteFinanc, string Actividade, string ProgMedida, int lAno)

Parameters

Type	Name	Description
System.String	TipoLancamento	Tipo de lançamento orçamental
System.String	Conta	numero de conta.
System.String	ClassEcon	Identificador da classificação económica.
System.String	ClassOrgan	Identificador da classificação orgânica.
System.String	ContaOrc	Identificador da conta orçamental.
System.String	FonteFinanc	Fonte de financiamento
System.String	Actividade	Atividade
System.String	ProgMedida	Programa/Medida
System.Int32	lAno

Returns

Type	Description
System.String

ValorAlteracoes(Int32, String, String, String, String, String, Int32)

Devolve o valor da alteração orçamental, para a chave orçamental definida

Declaration

decimal ValorAlteracoes(int Ano, string ClassOrgan, string ClassEcon, string FonteFinanc, string Actividade, string ProgMedida, int Alteracao = 0)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	ClassOrgan	Classificação orgânica.
System.String	ClassEcon	Classificação económica.
System.String	FonteFinanc	Fonte de financiamento.
System.String	Actividade	Atividade.
System.String	ProgMedida	Programa/medida.
System.Int32	Alteracao	Identificador da alteração orçamental.

Returns

Type	Description
System.Decimal	Valor da alteração orçamental, para a chave orçamental definida