Interface IOrcBSOrcamentos
Motor dos orçamentos
Namespace: IOrcBS100
Assembly: IOrcBS100.dll
Syntax
[ComVisible(true)]
[Guid("1D15CB10-05C0-4547-8EFC-FCBBD8DC3F06")]
public interface IOrcBSOrcamentosMethods
Actualiza(OrcBEOrcamento, String)
Procedimento para actualização do orçamento.
Declaration
void Actualiza(OrcBEOrcamento objBEOrcamento, string Avisos = "")Parameters
| Type | Name | Description |
|---|---|---|
| OrcBEOrcamento | objBEOrcamento | Objecto contendo a informação actualizada do orçamento. |
| System.String | Avisos | Notificação devolvida pelo processo de actualização. |
ActualizaValorAtributo(String, Int32, String, String, String, String, String, String, String, String, Object)
Actualiza o valor de um atributo.
Declaration
void ActualizaValorAtributo(string TipoLancamento, int Ano, string TipoOrc, string Conta, string ClassEcon, string ClassOrgan, string FonteFin, string Actividade, string ProgMedida, string Atributo, dynamic Valor)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Identificador do tipo de lançamento. |
| System.Int32 | Ano | Ano do exercício. |
| System.String | TipoOrc | Tipo de orçamento (Despesa ou Receita) |
| System.String | Conta | Conta financeira. |
| System.String | ClassEcon | Classificação económica. |
| System.String | ClassOrgan | Classificação orgânica. |
| System.String | FonteFin | Fonte de financiamento. |
| System.String | Actividade | Atividade. |
| System.String | ProgMedida | Programa/medida. |
| System.String | Atributo | Nome do atributo cujo valor será actualizado. |
| System.Object | Valor | Valor do atributo que será actualizado. |
ActualizaValorAtributos(String, Int32, String, String, String, String, String, String, String, StdBECampos)
Actualiza os valores respectivos de um conjunto de atributos.
Declaration
void ActualizaValorAtributos(string TipoLancamento, int Ano, string TipoOrc, string Conta, string ClassEcon, string ClassOrgan, string FonteFin, string Actividade, string ProgMedida, StdBECampos Atributos)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Identificador do tipo de lançamento. |
| System.Int32 | Ano | Ano do exercício. |
| System.String | TipoOrc | Tipo de orçamento (Despesa ou Receita) |
| System.String | Conta | Conta financeira. |
| System.String | ClassEcon | Classificação económica. |
| System.String | ClassOrgan | Classificação orgânica. |
| System.String | FonteFin | Fonte de financiamento. |
| System.String | Actividade | Atividade. |
| System.String | ProgMedida | Programa/medida. |
| StdBECampos | Atributos | Identifica os atributos e os 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(String, Int32, String, String, String, String, String, String, String, String)
Devolve o valor de um atributo.
Declaration
dynamic DaValorAtributo(string TipoLancamento, int Ano, string TipoOrc, string Conta, string ClassEcon, string ClassOrgan, string FonteFin, string Actividade, string ProgMedida, string Atributo)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Identificador do tipo de lançamento. |
| System.Int32 | Ano | Ano do exercício. |
| System.String | TipoOrc | Tipo de orçamento (Despesa ou Receita) |
| System.String | Conta | Conta financeira. |
| System.String | ClassEcon | Classificação económica. |
| System.String | ClassOrgan | Classificação orgânica. |
| System.String | FonteFin | Fonte de financiamento. |
| System.String | Actividade | Atividade. |
| System.String | ProgMedida | Programa/medida. |
| 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, String, String, String, String, String, String, Object[])
Devolve o valor de um conjunto de atributos.
Declaration
StdBECampos DaValorAtributos(string TipoLancamento, int Ano, string TipoOrc, string Conta, string ClassEcon, string ClassOrgan, string FonteFin, string Actividade, string ProgMedida, params dynamic[] Atributos)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Identificador do tipo de lançamento. |
| System.Int32 | Ano | Ano do exercício. |
| System.String | TipoOrc | Tipo de orçamento (Despesa ou Receita) |
| System.String | Conta | Conta financeira. |
| System.String | ClassEcon | Classificação económica. |
| System.String | ClassOrgan | Classificação orgânica. |
| System.String | FonteFin | Fonte de financiamento. |
| System.String | Actividade | Atividade. |
| System.String | ProgMedida | Programa/medida. |
| 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 |
Edita(String, Int32, String, String, String, String, String, String, String)
Edição de um orçamento, tendo por base a respetiva chave orçamental.
Declaration
OrcBEOrcamento Edita(string TipoLancamento, int Ano, string TipoOrc, string Conta, string ClassEcon, string ClassOrgan, string FonteFin, string Actividade, string ProgMedida)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Identificador do tipo de lançamento. |
| System.Int32 | Ano | Ano do exercício. |
| System.String | TipoOrc | Tipo de orçamento (Despesa ou Receita) |
| System.String | Conta | Conta financeira. |
| System.String | ClassEcon | Classificação económica. |
| System.String | ClassOrgan | Classificação orgânica. |
| System.String | FonteFin | Fonte de financiamento. |
| System.String | Actividade | Atividade. |
| System.String | ProgMedida | Programa/medida. |
Returns
| Type | Description |
|---|---|
| OrcBEOrcamento | Objecto com a informação do orçamento atualizada. |
Existe(String, Int32, String, String, String, String, String, String, String)
Verifica se já existe orçamento para a chave orçamental passada por parâmetro
Declaration
bool Existe(string TipoLancamento, int Ano, string TipoOrc, string Conta, string ClassEcon, string ClassOrgan, string FonteFin, string Actividade, string ProgMedida)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Identificador do tipo de lançamento. |
| System.Int32 | Ano | Ano do exercício. |
| System.String | TipoOrc | Tipo de orçamento (Despesa ou Receita) |
| System.String | Conta | Conta financeira. |
| System.String | ClassEcon | Classificação económica. |
| System.String | ClassOrgan | Classificação orgânica. |
| System.String | FonteFin | Fonte de financiamento. |
| System.String | Actividade | Atividade. |
| System.String | ProgMedida | Programa/medida. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true se existe, false caso contrário |
lstOrcamentos(String, Int32)
Listagem dos orçamentos.
Declaration
StdBELista lstOrcamentos(string TipoLancamento, int Ano)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Identificador do tipo de lançamento. |
| System.Int32 | Ano | Ano do exercício. |
Returns
| Type | Description |
|---|---|
| StdBELista | Orçamento do tipo de lançamento e ano passados por parâmetro |
Remove(String, Int32, String, String, String, String, String, String, String)
Procedimento para remoção de classificações orgânicas. Parte do príncipio que as validações já foram efectuadas.
Declaration
void Remove(string TipoLancamento, int Ano, string TipoOrc, string ClassEcon, string Conta, string ClassOrgan, string FonteFin, string Actividade, string ProgMedida)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Identificador do tipo de lançamento. |
| System.Int32 | Ano | Ano do exercício. |
| System.String | TipoOrc | Tipo de orçamento (Despesa ou Receita) |
| System.String | ClassEcon | Classificação económica. |
| System.String | Conta | Conta financeira. |
| System.String | ClassOrgan | Classificação orgânica. |
| System.String | FonteFin | Fonte de financiamento. |
| System.String | Actividade | Atividade. |
| System.String | ProgMedida | Programa/medida. |
ValidaActualizacao(OrcBEOrcamento, String)
Efectua a validação da informação do orçamento.
Declaration
bool ValidaActualizacao(OrcBEOrcamento BEOrcamentoCBL, string ErroValidacao)Parameters
| Type | Name | Description |
|---|---|---|
| OrcBEOrcamento | BEOrcamentoCBL | 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(String, Int32, String, String, String, String, String, String, String, ref String)
Efectua as validações necessárias à remoção do orçamento.
Declaration
bool ValidaRemocao(string TipoLancamento, int Ano, string TipoOrc, string Conta, string ClassEcon, string ClassOrgan, string FonteFin, string Actividade, string ProgMedida, ref string ErroValidacao)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Identificador do tipo de lançamento. |
| System.Int32 | Ano | Ano do exercício. |
| System.String | TipoOrc | Tipo de orçamento (Despesa ou Receita) |
| System.String | Conta | Conta financeira. |
| System.String | ClassEcon | Classificação económica. |
| System.String | ClassOrgan | Classificação orgânica. |
| System.String | FonteFin | Fonte de financiamento. |
| System.String | Actividade | Atividade. |
| System.String | ProgMedida | Programa/medida. |
| 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 |
ValorOrcamentoCorrigido(Int32, String, String, String, String, String, String, String, Int32, Int32)
Devolve o valor do orçamento corrigido (após modificações orçamentais) da chave orçamental passada por parâmetro
Declaration
double ValorOrcamentoCorrigido(int Ano, string ReceitaDespesa, string Conta, string Organica, string FonteFinanc, string Actividade, string ProgMedida, string Economica, int MesInicial, int MesFinal)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | Ano | Ano do exercício. |
| System.String | ReceitaDespesa | Tipo de orçamento (Despesa ou Receita) |
| System.String | Conta | Conta financeira |
| 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.Int32 | MesInicial | Mês inicial |
| System.Int32 | MesFinal | Mês final |
Returns
| Type | Description |
|---|---|
| System.Double | Valor do orçamento corrigido (após modificações orçamentais) da chave orçamental passada por parâmetro |
VerificaLancamentoConta(Int32, String, String, String, String, String, String, String, String)
Procedimento para efetuar a verificação
Declaration
bool VerificaLancamentoConta(int Ano, string TipoOrc, string TipoLancamento, string Conta, string ClassEcon, string ClassOrgan, string FonteFin, string Actividade, string ProgMedida)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | Ano | Ano do exercício. |
| System.String | TipoOrc | Tipo de orçamento (Despesa ou Receita) |
| System.String | TipoLancamento | Tipo de lançamento contabilístico |
| System.String | Conta | Conta financeira |
| System.String | ClassEcon | Classificação económica. |
| System.String | ClassOrgan | Classificação orgânica. |
| System.String | FonteFin | |
| System.String | Actividade | Atividade |
| System.String | ProgMedida | Programa/Medida |
Returns
| Type | Description |
|---|---|
| System.Boolean | true caso a validação suceda, false caso contrário |