Interface IOrcBSFormulasFluxo
Motor das fórmulas dos fluxos de caixa
Namespace: IOrcBS100
Assembly: IOrcBS100.dll
Syntax
[ComVisible(true)]
[Guid("1ACBAC1E-EE0F-4531-99CE-F7BBB6669856")]
public interface IOrcBSFormulasFluxo
Methods
Actualiza(OrcBEFormulaFluxo, String)
Procedimento para actualização da fórmula do fluxo de caixa.
Declaration
void Actualiza(OrcBEFormulaFluxo BEFormulasFluxo, string Avisos = "")
Parameters
| Type | Name | Description |
|---|---|---|
| OrcBEFormulaFluxo | BEFormulasFluxo | Objecto contendo a informação actualizada da fórmula do fluxo de caixa. |
| System.String | Avisos | Notificação devolvida pelo processo de actualização. |
ActualizaValorAtributo(String, Int32, String, String, Object)
Actualiza o valor de um atributo usando o ano de trabalho.
Declaration
void ActualizaValorAtributo(string TpExerc, int Linha, string ordem, string Atributo, dynamic Valor)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TpExerc | Identificador do tipo de exercício. |
| System.Int32 | Linha | Identificador da linha da formula. |
| System.String | ordem | Identificador da ordem da formula. |
| System.String | Atributo | Nome do atributo cujo valor será actualizado. |
| System.Object | Valor | Valor do atributo que será actualizado. |
ActualizaValorAtributoAno(String, Int32, Int32, String, String, Object)
Actualiza o valor de um atributo do ano passado por parâmetro.
Declaration
void ActualizaValorAtributoAno(string TpExerc, int Ano, int Linha, string ordem, string Atributo, dynamic Valor)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TpExerc | Identificador do tipo de exercício. |
| System.Int32 | Ano | Ano do exercício. |
| System.Int32 | Linha | Identificador da linha da formula. |
| System.String | ordem | Identificador da ordem da formula. |
| System.String | Atributo | Nome do atributo cujo valor será actualizado. |
| System.Object | Valor | Valor do atributo que será actualizado. |
ActualizaValorAtributos(String, Int32, String, StdBECampos)
Actualiza os valores respectivos de um conjunto de atributos.
Declaration
void ActualizaValorAtributos(string TpExerc, int Linha, string ordem, StdBECampos Atributos)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TpExerc | Identificador do tipo de exercício. |
| System.Int32 | Linha | Identificador da linha da formula. |
| System.String | ordem | Identificador da ordem da formula. |
| StdBECampos | Atributos | Identifica os atributos e os respectivos valores a actualizar. |
ActualizaValorAtributosAno(String, Int32, Int32, String, StdBECampos)
Actualiza os valores respectivos de um conjunto de atributos.
Declaration
void ActualizaValorAtributosAno(string TpExerc, int Ano, int Linha, string ordem, StdBECampos Atributos)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TpExerc | Identificador do tipo de exercício. |
| System.Int32 | Ano | Ano do exercício. |
| System.Int32 | Linha | Identificador da linha da formula. |
| System.String | ordem | Identificador da ordem da formula. |
| 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)
Devolve o valor de um atributo.
Declaration
dynamic DaValorAtributo(string TpExerc, int Linha, string ordem, string Atributo)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TpExerc | Identificador do tipo de exercício. |
| System.Int32 | Linha | Identificador da linha da formula. |
| System.String | ordem | Identificador da ordem da formula. |
| System.String | Atributo | Nome do atributo cujo valor será devolvido. |
Returns
| Type | Description |
|---|---|
| System.Object | Valor do atributo passado por parâmetro |
DaValorAtributoAno(String, Int32, Int32, String, String)
Devolve o valor de um atributo.
Declaration
dynamic DaValorAtributoAno(string TpExerc, int Ano, int Linha, string ordem, string Atributo)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TpExerc | Identificador do tipo de exercício. |
| System.Int32 | Ano | Ano do exercício. |
| System.Int32 | Linha | Identificador da linha da formula. |
| System.String | ordem | Identificador da ordem da formula. |
| 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, Object[])
Devolve o valor de um conjunto de atributos.
Declaration
StdBECampos DaValorAtributos(string TpExerc, int Linha, string ordem, params dynamic[] Atributos)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TpExerc | Identificador do tipo de exercício. |
| System.Int32 | Linha | Identificador da linha da formula. |
| System.String | ordem | Identificador da ordem da formula. |
| 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 |
DaValorAtributosAno(String, Int32, Int32, String, Object[])
Devolve o valor de um conjunto de atributos.
Declaration
StdBECampos DaValorAtributosAno(string TpExerc, int Ano, int Linha, string ordem, params dynamic[] Atributos)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TpExerc | Identificador do tipo de exercício. |
| System.Int32 | Ano | Ano do exercício. |
| System.Int32 | Linha | Identificador da linha da formula. |
| System.String | ordem | Identificador da ordem da formula. |
| 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)
Edição de uma fórmula do fluxo de caixa.
Declaration
OrcBEFormulaFluxo Edita(string TpExerc, int Linha)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TpExerc | Identificador do tipo de exercício. |
| System.Int32 | Linha | Identificador da linha da formula. |
Returns
| Type | Description |
|---|---|
| OrcBEFormulaFluxo |
EditaAno(String, Int32, Int32)
Edição de uma fórmula do fluxo de caixa, num determinado ano.
Declaration
OrcBEFormulaFluxo EditaAno(string TpExerc, int Ano, int Linha)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TpExerc | Identificador do tipo de exercício. |
| System.Int32 | Ano | Ano do exercício. |
| System.Int32 | Linha | Identificador da linha da fórmula. |
Returns
| Type | Description |
|---|---|
| OrcBEFormulaFluxo |
Existe(String, Int32)
Verifica se já existe a fórmula do fluxo de caixa.
Declaration
bool Existe(string TpExerc, int Linha)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TpExerc | Identificador do tipo de exercício. |
| System.Int32 | Linha | Identificador da linha da formula. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true se existe, false caso contrário |
ExisteAno(String, Int32, Int32)
Verifica se já existe a fórmula do fluxo de caixa.
Declaration
bool ExisteAno(string TpExerc, int Ano, int Linha)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TpExerc | Identificador do tipo de exercício. |
| System.Int32 | Ano | Ano do exercício. |
| System.Int32 | Linha | Identificador da linha da fórmula. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true se existe, false caso contrário |
lstFormulasFluxos()
Listagem das fórmula do fluxo de caixa.
Declaration
StdBELista lstFormulasFluxos()
Returns
| Type | Description |
|---|---|
| StdBELista | Lista das fórmula do fluxo de caixa. |
Remove(String, Int32)
Procedimento para remoção de fórmula do fluxo de caixa. Parte do príncipio que as validações já foram efectuadas.
Declaration
void Remove(string TpExerc, int Linha)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TpExerc | Identificador do tipo de exercício. |
| System.Int32 | Linha | Identificador da linha da formula. |
RemoveAno(String, Int32, Int32)
Procedimento para remoção de fórmula do fluxo de caixa, num determinado ano. Parte do príncipio que as validações já foram efectuadas.
Declaration
void RemoveAno(string TpExerc, int Ano, int Linha)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TpExerc | Identificador do tipo de exercício. |
| System.Int32 | Ano | Ano do exercício. |
| System.Int32 | Linha | Identificador da linha da formula. |
ValidaActualizacao(OrcBEFormulaFluxo, String)
Efectua a validação da informação da fórmula do fluxo de caixa.
Declaration
bool ValidaActualizacao(OrcBEFormulaFluxo BEFormulasFluxo, string ErroValidacao)
Parameters
| Type | Name | Description |
|---|---|---|
| OrcBEFormulaFluxo | BEFormulasFluxo | 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, ref String)
Efectua as validações necessárias à remoção da fórmula do fluxo de caixa com o ano de trabalho.
Declaration
bool ValidaRemocao(string TpExerc, int Linha, ref string ErroValidacao)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TpExerc | Identificador do tipo de exercício. |
| System.Int32 | Linha | Identificador da linha da formula. |
| 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 |
ValidaRemocaoAno(String, Int32, Int32, ref String)
Efectua as validações necessárias à remoção da fórmula do fluxo de caixa tendo por base o ano passado por parâmetro.
Declaration
bool ValidaRemocaoAno(string TpExerc, int Ano, int Linha, ref string ErroValidacao)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | TpExerc | Identificador do tipo de exercício. |
| System.Int32 | Ano | Ano do exercício. |
| System.Int32 | Linha | Identificador do linha da formula. |
| 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 |