Interface IOrcBSProcessoExecucao

Motor dos processos de execução

Namespace: IOrcBS100

Assembly: IOrcBS100.dll

Syntax

[ComVisible(true)]
[Guid("7BB8D48F-01E4-4231-895F-326FE2654ED9")]
public interface IOrcBSProcessoExecucao

Methods

Actualiza(OrcBEProcessoExecucao)

Procedimento para actualização do processo de execução.

Declaration

void Actualiza(OrcBEProcessoExecucao BEProcessoExecucao)

Parameters

Type	Name	Description
OrcBEProcessoExecucao	BEProcessoExecucao	Objecto contendo a informação actualizada do processo de execução.

Actualiza(OrcBEProcessoExecucao, ref String)

Procedimento para actualização do processo de execução.

Declaration

void Actualiza(OrcBEProcessoExecucao BEProcessoExecucao, ref string Avisos)

Parameters

Type	Name	Description
OrcBEProcessoExecucao	BEProcessoExecucao	Objecto contendo a informação actualizada do processo de execução.
System.String	Avisos	Notificação devolvida pelo processo de actualização.

ActualizaValorAtributo(String, Int32, String, Object)

Actualiza o valor de um atributo.

Declaration

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

Parameters

Type	Name	Description
System.String	Processo	Identificador do Processo de Execução.
System.Int32	Ano	Ano do exercício.
System.String	Atributo	Nome do atributo cujo valor será actualizado.
System.Object	Valor	Valor do atributo que será actualizado.

ActualizaValorAtributos(String, Int32, StdBECampos)

Actualiza os valores respectivos de um conjunto de atributos.

Declaration

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

Parameters

Type	Name	Description
System.String	Processo	Identificador do Processo de Execução.
System.Int32	Ano	Ano do exercício.
StdBECampos	Atributos	Identifica os atributos e os respectivos valores a actualizar.

DaDataAnterior(String, ref Int32, ref Int32, ref Int32)

Devolve a data anterior movimentada no processo de execução.

Declaration

bool DaDataAnterior(string Processo, ref int Dia, ref int Mes, ref int Ano)

Parameters

Type	Name	Description
System.String	Processo	Processo de execução.
System.Int32	Dia	Dia
System.Int32	Mes	Mês
System.Int32	Ano	Ano

Returns

Type	Description
System.Boolean	Data anterior movimentada no processo de execução.

DaDefCamposUtil()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

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

DaDefCamposUtilLinhas()

Devolve as definições dos campos do utilizador das linhas do processo de execução.

Declaration

StdBEDefCamposUtil DaDefCamposUtilLinhas()

Returns

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

DaDefCamposUtilLinhasDim()

Devolve as definições dos campos do utilizador das linhas das dimensões orçamentais.

Declaration

StdBEDefCamposUtil DaDefCamposUtilLinhasDim()

Returns

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

DaDescricao(String, Int32)

Devolve a descrição do processo de execução

Declaration

string DaDescricao(string Processo, int Ano)

Parameters

Type	Name	Description
System.String	Processo	Código do processo de execução.
System.Int32	Ano	Ano do exercício.

Returns

Type	Description
System.String	Descrição do processo de execução

DaLinhaProcesso(String, Int32, String, String, String, String, String, String)

Devolve a linha do processo de determinada chave orçamental

Declaration

int DaLinhaProcesso(string Processo, int Ano, string ClassOrgan, string FonteFinanc, string Actividade, string ProgMedida, string ClassEcon, string Conta)

Parameters

Type	Name	Description
System.String	Processo	Processo de execução
System.Int32	Ano	Ano do exercício.
System.String	ClassOrgan	Classificação orgânica.
System.String	FonteFinanc	Fonte de financiamento
System.String	Actividade	Atividade
System.String	ProgMedida	Programa/Medida
System.String	ClassEcon	Classificação económica.
System.String	Conta	Conta orçamental

Returns

Type	Description
System.Int32	Linha do processo de determinada chave orçamental. Devolve 0 caso não exista.

DaValorAtributo(String, Int32, String)

Devolve o valor de um atributo.

Declaration

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

Parameters

Type	Name	Description
System.String	Processo	Identificador do Processo de Execução.
System.Int32	Ano	Ano do exercício.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

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

DaValorAtributoLinha(String, Int32, Int32, String)

Devolve o valor de um atributo da linha do processo de execução.

Declaration

dynamic DaValorAtributoLinha(string Processo, int Ano, int Linha, string Atributo)

Parameters

Type	Name	Description
System.String	Processo	Processo de execução.
System.Int32	Ano	Ano do exercício.
System.Int32	Linha	Linha
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

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

DaValorAtributoLinhaLock(String, Int32, Int32, String)

Devolve o valor de um atributo da linha de um processo de execução, respeitando os locks da base de dados.

Declaration

dynamic DaValorAtributoLinhaLock(string Processo, int Ano, int Linha, string Atributo)

Parameters

Type	Name	Description
System.String	Processo	Identificador do Processo de Execução.
System.Int32	Ano	Ano do exercício.
System.Int32	Linha	Identificador da Linha do Processo de Execução.
System.String	Atributo

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

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Processo	Identificador do Processo de execução.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

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

DaValorAtributos(String, Int32, String[])

Devolve o valor de um conjunto de atributos.

Declaration

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

Parameters

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

DaValorAtributosLinha(String, Int32, Int32, String[])

Devolve o valor de um conjunto de atributos da linha do processo de execução.

Declaration

StdBECampos DaValorAtributosLinha(string Processo, int Ano, int Linha, params string[] Atributos)

Parameters

Type	Name	Description
System.String	Processo	Identificador da classificação orgânica.
System.Int32	Ano	Ano do exercício.
System.Int32	Linha	Identificador da Linha do Processo de Execução.
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

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 Processo, string[] Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Processo	Identificador do Processo de execução.
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

DaValorEstado(String, Int32, Int32, String)

Devolve o valor do estado orçamental movimentado em determinada linha

Declaration

decimal DaValorEstado(string Processo, int Ano, int Linha, string Estado)

Parameters

Type	Name	Description
System.String	Processo	Identificador do processo de execução.
System.Int32	Ano	Ano do exercício.
System.Int32	Linha	Linha do processo
System.String	Estado	Identificador do Estado

Returns

Type	Description
System.Decimal	Valor do estado orçamental movimentado.

DaValorEstadoAno(String, Int32, String, Int32)

Devolve o valor do estado orçamental movimentado.

Declaration

decimal DaValorEstadoAno(string Processo, int Linha, string Estado, int Ano)

Parameters

Type	Name	Description
System.String	Processo	Processo de execução.
System.Int32	Linha	Linha do processo de execução.
System.String	Estado	Estado orçamental.
System.Int32	Ano	Ano do exercício.

Returns

Type	Description
System.Decimal	Valor movimentado.

DaValorEstadoAno(String, Int32, String, Int32, String)

Da somatório do valor do estado nos movimentos dos processos

Declaration

decimal DaValorEstadoAno(string Processo, int Linha, string Estado, int Ano, string IdContrato)

Parameters

Type	Name	Description
System.String	Processo	Processo de execução.
System.Int32	Linha
System.String	Estado
System.Int32	Ano	Ano do exercício.
System.String	IdContrato	ID do contrato

Returns

Type	Description
System.Decimal	Somatório do valor do estado nos movimentos dos processos

DaValorMovDimensao(OrcBELinhaDimProcExecucao, String, Int32, Int32, String)

Devolve o valor do estado orçamental movimentado numa dimensão orçamental.

Declaration

decimal DaValorMovDimensao(OrcBELinhaDimProcExecucao BELinhaDimProcExecucao, string Diario, int NumDiario, int Ano, string Estado)

Parameters

Type	Name	Description
OrcBELinhaDimProcExecucao	BELinhaDimProcExecucao	Objecto com informação da linha da dimensão orçamental
System.String	Diario	Diário contabilístico
System.Int32	NumDiario	Numerador do diário contabilístico
System.Int32	Ano	Ano do exercício.
System.String	Estado	Estado orçamental.

Returns

Type	Description
System.Decimal	Valor movimentado.

DaValorMovDimensaoProc(OrcBELinhaDimProcExecucao, String, Int32, Int32)

Devolve o valor do estado orçamental movimentado numa dimensão orçamental.

Declaration

decimal DaValorMovDimensaoProc(OrcBELinhaDimProcExecucao BELinhaDimProcExecucao, string Processo, int LinhaProc, int Ano)

Parameters

Type	Name	Description
OrcBELinhaDimProcExecucao	BELinhaDimProcExecucao	Objecto com informação da linha da dimensão orçamental.
System.String	Processo	Processo de execução.
System.Int32	LinhaProc	Linha do processo de execução
System.Int32	Ano	Ano do exercício.

Returns

Type	Description
System.Decimal	Valor movimentado.

Edita(String, Int32)

Edição de um processo de execução.

Declaration

OrcBEProcessoExecucao Edita(string Processo, int Ano)

Parameters

Type	Name	Description
System.String	Processo	Identificador do Processo de Execução.
System.Int32	Ano	Ano do exercício.

Returns

Type	Description
OrcBEProcessoExecucao	Objecto com a informação do processo de execução atualizada.

EditaLinhaDim(String)

Edita as linhas dimensão de determinada linha de processo de execução.

Declaration

OrcBELinhasDimProcExecucao EditaLinhaDim(string IdLinhaProc)

Parameters

Type	Name	Description
System.String	IdLinhaProc	ID da linha do processo de execução.

Returns

Type	Description
OrcBELinhasDimProcExecucao	Objecto com as linhas dimensão de determinada linha de processo de execução.

EditaProcessosExec(String[,])

Edição de vários processo de execução.

Declaration

OrcBEProcessoExecucao[] EditaProcessosExec(string[, ] ProcessosAnos)

Parameters

Type	Name	Description
System.String[,]	ProcessosAnos	Identificardor de processos de execução [Processos, Anos]

Returns

Type	Description
OrcBEProcessoExecucao[]	Array com a informação do processo de execução atualizada.

EstadoValidaContrato(Int32, String, String)

Valida se o estado é posterior ao estado mínimo para validação dos contratos indicado nos parâmetros do exercício.

Declaration

bool EstadoValidaContrato(int Ano, string Estado, string TipoProcesso)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Estado	Estado na linha do processo a validar.
System.String	TipoProcesso	Tipo processo.

Returns

Type	Description
System.Boolean

Existe(String, Int32)

Verifica se já existe o Processo de Execução.

Declaration

bool Existe(string Processo, int Ano)

Parameters

Type	Name	Description
System.String	Processo	Identificador do Processo de Execução.
System.Int32	Ano	Ano do exercício.

Returns

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

ExisteLinha(String, Int32, Int32)

Verifica se já existe a linha do Processo de Execução.

Declaration

bool ExisteLinha(string Processo, int Ano, int Linha)

Parameters

Type	Name	Description
System.String	Processo	Identificador do Processo.
System.Int32	Ano	Ano do exercício.
System.Int32	Linha	Identificador da Linha do Processo de Execução.

Returns

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

ExisteProcesso(String)

Verifica se já existe o Processo, independentemente do ano.

Declaration

bool ExisteProcesso(string Processo)

Parameters

Type	Name	Description
System.String	Processo	Identificador do Processo.

Returns

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

GeraValorMaximo(String)

Gera valor máximo

Declaration

string GeraValorMaximo(string StrChave)

Parameters

Type	Name	Description
System.String	StrChave	Chave

Returns

Type	Description
System.String	Valor máximo.

ListaProcessosExecucao()

Listagem dos Processos de Execução.

Declaration

StdBELista ListaProcessosExecucao()

Returns

Type	Description
StdBELista	Lista de processos de execução no formato StdBELista.

PodeAlterarValor(String, Int32, String, Int32, Decimal, ref Decimal)

Indica se o valor do processo de execução pode ser alterado.

Declaration

bool PodeAlterarValor(string Processo, int Ano, string TipoProcesso, int Linha, decimal NovoValor, ref decimal Valor)

Parameters

Type	Name	Description
System.String	Processo	Processo de execução
System.Int32	Ano	Ano do exercício.
System.String	TipoProcesso	Tipo de processo.
System.Int32	Linha	Linha do processo.
System.Decimal	NovoValor	Novo valor para o processo.
System.Decimal	Valor	Valor

Returns

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

Remove(String, Int32)

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

Declaration

void Remove(string Processo, int Ano)

Parameters

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

UltimoDocumento(OrcBEProcessoExecucao)

Declaration

bool UltimoDocumento(OrcBEProcessoExecucao BEProcessoExecucao)

Parameters

Type	Name	Description
OrcBEProcessoExecucao	BEProcessoExecucao

Returns

Type	Description
System.Boolean

ValidaActualizacao(OrcBEProcessoExecucao, ref String)

Efectua a validação da informação do Processo de Execução.

Declaration

bool ValidaActualizacao(OrcBEProcessoExecucao BEProcessoExecucao, ref string ErroValidacao)

Parameters

Type	Name	Description
OrcBEProcessoExecucao	BEProcessoExecucao	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

ValidaActualizacao(OrcBEProcessoExecucao, ref String, ref String)

Efectua a validação da informação do Processo de Execução.

Declaration

bool ValidaActualizacao(OrcBEProcessoExecucao BEProcessoExecucao, ref string ErroValidacao, ref string Avisos)

Parameters

Type	Name	Description
OrcBEProcessoExecucao	BEProcessoExecucao	Objecto contendo a informação que se pretende validar.
System.String	ErroValidacao	Recebe a descrição de eventuais erros detetados.
System.String	Avisos	Recebe a descrição de eventuais avisos de gravação.

Returns

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

ValidaProjetoEWBSItemEmUso(Int32, String, String)

Valida se o projeto e elemento PEP estão em uso em processos de execução

Declaration

bool ValidaProjetoEWBSItemEmUso(int Ano, string IdProjeto, string WBSItem)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	IdProjeto	ID do projeto
System.String	WBSItem	Elem. do plano de execução do projeto

Returns

Type	Description
System.Boolean

ValidaRemocao(String, Int32, ref String)

Efectua as validações necessárias à remoção do Processo de Execução

Declaration

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

Parameters

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

ValorMovimEstado(Int32, String, Int32, Int32, String, String, String, String, String, String)

Devolve o valor do estado orçamental movimentado tendo por base determinada chave orçamental.

Declaration

double ValorMovimEstado(int Ano, string Estado, int MesInicial, int MesFinal, string Organica = "", string FonteFinanc = "", string Actividade = "", string ProgMedida = "", string Economica = "", string ContaOrc = "")

Parameters

Type	Name	Description
System.Int32	Ano	Ano do exercício.
System.String	Estado	Estado orçamental
System.Int32	MesInicial	Mês inicial
System.Int32	MesFinal	Mês final
System.String	Organica	Classificação orgânica
System.String	FonteFinanc	Fonte de financiamento.
System.String	Actividade	Atividade
System.String	ProgMedida	Programa/Medida
System.String	Economica	Classificação económica
System.String	ContaOrc	Conta orçamental.

Returns

Type	Description
System.Double	Valor movimentado.

ValorRealizadoIni(String, Int32, Int32)

Procedimento para cálculo do valor realizado inicial, para o processo e linha definidos

Declaration

decimal ValorRealizadoIni(string Processo, int Linha, int Ano)

Parameters

Type	Name	Description
System.String	Processo	Código do processo de execução
System.Int32	Linha	Linha
System.Int32	Ano	Ano do exercício.

Returns

Type	Description
System.Decimal	Valor realizado inicial