Interface ICblBSPlanoFuncional

Classe utilizada para obter serviços e regras de negócio sobre Funções.

Namespace: ICblBS100

Assembly: ICblBS100.dll

Syntax

[ComVisible(true)]
[Guid("393024D5-31BE-471E-BBE0-CF38B31EBC00")]
public interface ICblBSPlanoFuncional

Methods

Actualiza(CblBEFuncao)

Actualiza a informação do Plano Funcional.

Declaration

void Actualiza(CblBEFuncao objBEFuncao)

Parameters

Type	Name	Description
CblBEFuncao	objBEFuncao	Objecto contendo a informação actualizada do Plano Funcional.

Actualiza(CblBEFuncao, ref String)

Actualiza a informação do Plano Funcional.

Declaration

void Actualiza(CblBEFuncao objBEFuncao, ref string Avisos)

Parameters

Type	Name	Description
CblBEFuncao	objBEFuncao	Objecto contendo a informação actualizada do Plano Funcional.
System.String	Avisos	Notificação devolvida pelo processo de actualização.

ActualizaValorAtributo(Int32, String, String, Object)

Actualiza o valor de um atributo.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Funcao	Identificador da Função.
System.String	Atributo	Nome do atributo cujo valor será actualizado.
System.Object	Valor	Valor do atributo que será actualizado.

ActualizaValorAtributos(Int32, String, StdBECampos)

Actualiza os valores respectivos de um conjunto de atributos.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Funcao	Identificador da Função.
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

DaDescricao(Int32, String)

Descrição associada ao Plano Funcional.

Declaration

string DaDescricao(int Ano, string Funcao)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Funcao	Identificador da Função.

Returns

Type	Description
System.String

DaFuncaoConsolidacao(Int32, String)

Devolve a Função de Consolidação

Declaration

string DaFuncaoConsolidacao(int Ano, string Funcao)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Funcao	Identificador da Função.

Returns

Type	Description
System.String

DaValorAtributo(Int32, String, String)

Devolve o valor de um atributo.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Funcao	Identificador da Função.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

Type	Description
System.Object

DaValorAtributoLock(Int32, String, String)

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

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Funcao	Identificador da Função.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

Type	Description
System.Object

DaValorAtributos(Int32, String, Object[])

Devolve o valor de um conjunto de atributos.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Funcao	Identificador da Função.
System.Object[]	Atributos	Conjunto de atributos dos quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosLock(Int32, String, Object[])

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

Declaration

StdBECampos DaValorAtributosLock(int Ano, string Funcao, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Funcao	Identificador da Função.
System.Object[]	Atributos	Conjunto de atributos dos quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

Edita(Int32, String)

Edita a informação do Plano Funcional.

Declaration

CblBEFuncao Edita(int Ano, string Funcao)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Funcao	Identificador da Função.

Returns

Type	Description
CblBEFuncao

Existe(Int32, String)

Verifica se existe o Plano Funcional.

Declaration

bool Existe(int Ano, string Funcao)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Funcao	Identificador da Função.

Returns

Type	Description
System.Boolean

ExisteFuncaoLancamento(Int32, String, ref String)

Verifica se existe o Plano Funcional, e no caso de existir devolve o tipo (M,I ou R).

Declaration

bool ExisteFuncaoLancamento(int Ano, string Funcao, ref string TipoConta)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Funcao	Identificador da Função.
System.String	TipoConta	Identificador do Tipo de Conta.

Returns

Type	Description
System.Boolean

GeraSqlWhereCategoriaSubQuery()

Devolve uma string SQL com base nas condições existentes nos filtros da categoria Plano de Contas.

Declaration

string GeraSqlWhereCategoriaSubQuery()

Returns

Type	Description
System.String

GeraSqlWhereCategoriaSubQuery(ref String)

Devolve uma string SQL com base nas condições existentes nos filtros da categoria Plano de Contas.

Declaration

string GeraSqlWhereCategoriaSubQuery(ref string TabelaPrincipal)

Parameters

Type	Name	Description
System.String	TabelaPrincipal	Tabela principal da categoria.

Returns

Type	Description
System.String

GeraSqlWhereCategoriaSubQuery(ref String, ref String)

Devolve uma string SQL com base nas condições existentes nos filtros da categoria Plano de Contas.

Declaration

string GeraSqlWhereCategoriaSubQuery(ref string TabelaPrincipal, ref string CampoPrincipal)

Parameters

Type	Name	Description
System.String	TabelaPrincipal	Tabela principal da categoria.
System.String	CampoPrincipal	Campo principal da categoria.

Returns

Type	Description
System.String

GeraSqlWhereCategoriaSubQuery(ref String, ref String, ref String)

Devolve uma string SQL com base nas condições existentes nos filtros da categoria Plano de Contas.

Declaration

string GeraSqlWhereCategoriaSubQuery(ref string TabelaPrincipal, ref string CampoPrincipal, ref string TabelaFiltro)

Parameters

Type	Name	Description
System.String	TabelaPrincipal	Tabela principal da categoria.
System.String	CampoPrincipal	Campo principal da categoria.
System.String	TabelaFiltro	Tabela de sobre a qual será aplicada o filtro, quando diferente da tabela da categoria.

Returns

Type	Description
System.String

GeraSqlWhereCategoriaSubQuery(ref String, ref String, ref String, ref String)

Devolve uma string SQL com base nas condições existentes nos filtros da categoria Plano de Contas.

Declaration

string GeraSqlWhereCategoriaSubQuery(ref string TabelaPrincipal, ref string CampoPrincipal, ref string TabelaFiltro, ref string CampoFiltro)

Parameters

Type	Name	Description
System.String	TabelaPrincipal	Tabela principal da categoria.
System.String	CampoPrincipal	Campo principal da categoria.
System.String	TabelaFiltro	Tabela de sobre a qual será aplicada o filtro, quando diferente da tabela da categoria.
System.String	CampoFiltro	Campo que irá filtrar os dados.

Returns

Type	Description
System.String

GeraSqlWhereCategoriaSubQuery(ref String, ref String, ref String, ref String, String)

Devolve uma string SQL com base nas condições existentes nos filtros da categoria Plano de Contas.

Declaration

string GeraSqlWhereCategoriaSubQuery(ref string TabelaPrincipal, ref string CampoPrincipal, ref string TabelaFiltro, ref string CampoFiltro, string Utilizador)

Parameters

Type	Name	Description
System.String	TabelaPrincipal	Tabela principal da categoria.
System.String	CampoPrincipal	Campo principal da categoria.
System.String	TabelaFiltro	Tabela de sobre a qual será aplicada o filtro, quando diferente da tabela da categoria.
System.String	CampoFiltro	Campo que irá filtrar os dados.
System.String	Utilizador	Utilizador aos quais estão associadados os filtros da categoria, quando diferente do utilizador de Contexto.

Returns

Type	Description
System.String

LstFuncoes()

Listagem das Funções.

Declaration

StdBELista LstFuncoes()

Returns

Type	Description
StdBELista

Remove(Int32, String)

Remove um Plano Funcional.

Declaration

void Remove(int Ano, string Funcao)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Funcao	Identificador da Função.

ValidaActualizacao(CblBEFuncao, ref String)

Efectua a validação da informação do Plano Funcional.

Declaration

bool ValidaActualizacao(CblBEFuncao BEFuncao, ref string StrErro)

Parameters

Type	Name	Description
CblBEFuncao	BEFuncao	Objecto contendo a informação que se pretende validar.
System.String	StrErro

Returns

Type	Description
System.Boolean

ValidaOperacaoCategoria(Int32, String, ref String, Int32)

Devolve se o utilizador actual tem acesso a uma determinada Função do Plano Funcional, analisando os filtros da categoria.

Declaration

bool ValidaOperacaoCategoria(int Ano, string Funcao, ref string MsgErro, int Linha = -1)

Parameters

Type	Name	Description
System.Int32	Ano	Ano.
System.String	Funcao	Função.
System.String	MsgErro
System.Int32	Linha	Número da linha.

Returns

Type	Description
System.Boolean

ValidaRemocao(Int32, String, ref String)

Efectua as validações necessárias à remoção do Plano Funcional.

Declaration

bool ValidaRemocao(int Ano, string Funcao, ref string StrErro)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Funcao	Identificador da Função.
System.String	StrErro

Returns

Type	Description
System.Boolean