Interface IOrcBSAcumuladosDim
Motor dos acumulados por dimensão orçamental.
Namespace: IOrcBS100
Assembly: IOrcBS100.dll
Syntax
[ComVisible(true)]
[Guid("2CD16236-7F6C-4069-A62F-5DCCB0BF5FA6")]
public interface IOrcBSAcumuladosDimMethods
Actualiza(String, Int32, String[], String[], String, Int32, String, Double, String)
Procedimento para actualização.
Declaration
void Actualiza(string TipoLancamento, int Ano, string[] Dimensoes, string[] Codigos, string Estado, int Mes, string Natureza, double Valor, string Avisos = "")Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Tipo de lançamento contabilístico |
| System.Int32 | Ano | Ano do exercício. |
| System.String[] | Dimensoes | Identificador da dimensão orçamental. |
| System.String[] | Codigos | Código da dimensão orçamental. |
| System.String | Estado | Estado orçamental. |
| System.Int32 | Mes | Mês |
| System.String | Natureza | Identificador da natureza. |
| System.Double | Valor | Valor |
| System.String | Avisos | Notificação devolvida pelo processo de actualização. |
ActualizaValorAtributo(String, Int32, String[], String[], String, String, Decimal)
Actualiza o valor de um atributo.
Declaration
void ActualizaValorAtributo(string TipoLancamento, int Ano, string[] Dimensoes, string[] Codigos, string Estado, string Atributo, decimal Valor)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Tipo de lançamento contabilístico |
| System.Int32 | Ano | Ano do exercício. |
| System.String[] | Dimensoes | Identificador da dimensão orçamental. |
| System.String[] | Codigos | Código da dimensão orçamental. |
| System.String | Estado | Estado orçamental. |
| System.String | Atributo | Nome do atributo cujo valor será actualizado. |
| System.Decimal | Valor | Valor do atributo que será actualizado. |
ActualizaValorAtributos(String, Int32, String[], String[], String, StdBECampos)
Actualiza os valores respectivos de um conjunto de atributos.
Declaration
void ActualizaValorAtributos(string TipoLancamento, int Ano, string[] Dimensoes, string[] Codigos, string Estado, StdBECampos Atributos)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Tipo de lançamento contabilístico |
| System.Int32 | Ano | Ano do exercício. |
| System.String[] | Dimensoes | Identificador da dimensão orçamental. |
| System.String[] | Codigos | Código da dimensão orçamental. |
| System.String | Estado | Estado orçamental. |
| 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)
Devolve o valor de um atributo.
Declaration
dynamic DaValorAtributo(string TipoLancamento, int Ano, string[] Dimensoes, string[] Codigos, string Estado, string Atributo)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Tipo de lançamento contabilístico |
| System.Int32 | Ano | Ano do exercício. |
| System.String[] | Dimensoes | Identificador da dimensão orçamental. |
| System.String[] | Codigos | Código da dimensão orçamental. |
| System.String | Estado | Estado 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(String, Int32, String[], String[], String, Object[])
Devolve o valor de um conjunto de atributos.
Declaration
StdBECampos DaValorAtributos(string TipoLancamento, int Ano, string[] Dimensoes, string[] Codigos, string Estado, params dynamic[] Atributos)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Tipo de lançamento contabilístico |
| System.Int32 | Ano | Ano do exercício. |
| System.String[] | Dimensoes | Identificador da dimensão orçamental. |
| System.String[] | Codigos | Código da dimensão orçamental. |
| System.String | Estado | Estado 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 |
DaValorTotalRealizado(String[], String[], Int32)
Procedimento que devolve o total realizado para as dimensões identificadas, no ano passado por parâmetro
Declaration
decimal DaValorTotalRealizado(string[] Dimensoes, string[] Codigos, int Ano)Parameters
| Type | Name | Description |
|---|---|---|
| System.String[] | Dimensoes | Identificador da dimensão orçamental. |
| System.String[] | Codigos | Código da dimensão orçamental. |
| System.Int32 | Ano | Ano do exercício. |
Returns
| Type | Description |
|---|---|
| System.Decimal | Valor total realizado para as dimensões identificadas, no ano passado por parâmetro |
Edita(String, Int32, String[], String[], String)
Edição de uma lista de acumulados por dimensão orçamental.
Declaration
OrcBEAcumuladoDim Edita(string TipoLancamento, int Ano, string[] Dimensoes, string[] Codigos, string Estado)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Tipo de lançamento contabilístico. |
| System.Int32 | Ano | Ano do exercício. |
| System.String[] | Dimensoes | Dimensões orçamentais em análise. |
| System.String[] | Codigos | Códigos das dimensões em análise. |
| System.String | Estado | Estado a analisar. |
Returns
| Type | Description |
|---|---|
| OrcBEAcumuladoDim | Acumulados das dimensões identificadas. |
Existe(String, Int32, String[], String[], String)
Verifica se existem valores acumulados para as dimensões identificadas.
Declaration
bool Existe(string TipoLancamento, int Ano, string[] Dimensoes, string[] Codigos, string Estado)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Tipo de lançamento contabilístico. |
| System.Int32 | Ano | Ano do exercício. |
| System.String[] | Dimensoes | Lista de dimensões orçamentais a validar. |
| System.String[] | Codigos | Códigos das dimensões orçamentais a validar. |
| System.String | Estado | Estado a validar. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true se existe, false caso contrário |
lstAcumuladosDim()
Listagem dados acumulados de dimensões.
Declaration
StdBELista lstAcumuladosDim()Returns
| Type | Description |
|---|---|
| StdBELista | Dados acumulados de dimensões, no formato StdBELista |
Remove(String, Int32, String[], String[], String, Int32, String, Double)
Procedimento para remoção de Dimensões. Parte do príncipio que as validações já foram efectuadas.
Declaration
void Remove(string TipoLancamento, int Ano, string[] Dimensoes, string[] Codigos, string Estado, int Mes, string Natureza, double Valor)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Tipo de lançamento contabilístico |
| System.Int32 | Ano | Ano do exercício. |
| System.String[] | Dimensoes | Identificador da dimensão orçamental. |
| System.String[] | Codigos | Código da dimensão orçamental. |
| System.String | Estado | Estado orçamental. |
| System.Int32 | Mes | Mês |
| System.String | Natureza | Identificador da natureza. |
| System.Double | Valor | Valor |
ValidaActualizacao(String, Int32, String[], String[], String, Int32, String, Double, ref String)
Efectua a validação da informação da dos acumulados de dimensões.
Declaration
bool ValidaActualizacao(string TipoLancamento, int Ano, string[] Dimensoes, string[] Codigos, string Estado, int Mes, string Natureza, double Valor, ref string ErroValidacao)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Tipo de lançamento contabilístico |
| System.Int32 | Ano | Ano do exercício. |
| System.String[] | Dimensoes | Identificador da dimensão orçamental. |
| System.String[] | Codigos | Código da dimensão orçamental. |
| System.String | Estado | Estado orçamental. |
| System.Int32 | Mes | Mês |
| System.String | Natureza | Natureza do lançamento. |
| System.Double | Valor | Valor |
| 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, ref String)
Efectua as validações necessárias à remoção de acumulados de dimensões.
Declaration
bool ValidaRemocao(string TipoLancamento, int Ano, string[] Dimensoes, string[] Codigos, string Estado, ref string ErroValidacao)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Tipo de lançamento contabilístico |
| System.Int32 | Ano | Ano do exercício. |
| System.String[] | Dimensoes | Identificador da dimensão orçamental. |
| System.String[] | Codigos | Código da dimensão orçamental. |
| System.String | Estado | Estado 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 |
ValidaValDispDim(String, Int32, String[], String[], String, Int32, String, Decimal, ref String, Decimal, ref Int32, ref String[], ref String[], ref String, ref String, ref Decimal, ref Decimal)
Efetua a validação do valor disponível por dimensão orçamental
Declaration
bool ValidaValDispDim(string TipoLancamento, int Ano, string[] Dimensoes, string[] Codigos, string Estado, int Mes, string Natureza, decimal Valor, ref string ErroValidacao, decimal ValorAnterior, ref int TipoControlo, ref string[] DescDimensoes, ref string[] DescCodigos, ref string DescEstado, ref string Orcamento, ref decimal ValorOrc, ref decimal ValorExec)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TipoLancamento | Tipo de lançamento contabilístico |
| System.Int32 | Ano | Ano do exercício. |
| System.String[] | Dimensoes | Identificador da dimensão orçamental. |
| System.String[] | Codigos | Código da dimensão orçamental. |
| System.String | Estado | Estado orçamental. |
| System.Int32 | Mes | Mês |
| System.String | Natureza | Natureza |
| System.Decimal | Valor | Valor |
| System.String | ErroValidacao | Recebe a descrição de eventuais erros detetados. |
| System.Decimal | ValorAnterior | Valor anterior |
| System.Int32 | TipoControlo | |
| System.String[] | DescDimensoes | |
| System.String[] | DescCodigos | |
| System.String | DescEstado | |
| System.String | Orcamento | |
| System.Decimal | ValorOrc | |
| System.Decimal | ValorExec |
Returns
| Type | Description |
|---|---|
| System.Boolean | Valor disponível por dimensão orçamental |