Interface ICblBSGruposHierarquicos

Classe utilizada para obter serviços e regras de negócio sobre Grupos Hierárquicos.

Namespace: ICblBS100

Assembly: ICblBS100.dll

Syntax

[ComVisible(true)]
[Guid("C9EF4269-2A12-4E75-95A5-5AE2220E170B")]
public interface ICblBSGruposHierarquicos

Methods

Actualiza(CblBEGrupoHierarquico, String)

Actualiza a informação de um Grupo

Declaration

void Actualiza(CblBEGrupoHierarquico objBEGrupo, string Avisos = "")

Parameters

Type	Name	Description
CblBEGrupoHierarquico	objBEGrupo	Objecto contendo a informação actualizada do Grupo.
System.String	Avisos	Notificação devolvida pelo processo de actualização.

ActualizaCabecalho(CblBEGrupoHierarquico, String)

Actualiza a informação do cabeçalho de um Grupo.

Declaration

void ActualizaCabecalho(CblBEGrupoHierarquico objBEGrupo, string Avisos = "")

Parameters

Type	Name	Description
CblBEGrupoHierarquico	objBEGrupo	Objecto contendo a informação actualizada do Grupo.
System.String	Avisos	Notificação devolvida pelo processo de actualização.

ActualizaValorAtributo(Int32, String, String, String, Object)

Actualiza o valor de um atributo.

Declaration

void ActualizaValorAtributo(int Ano, string Grupo, string Tipo, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Grupo	grupo.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas
System.String	Atributo	Nome do atributo cujo valor será actualizado.
System.Object	Valor	Valor do atributo que será actualizado.

ActualizaValorAtributos(Int32, String, String, StdBECampos)

Actualiza os valores respectivos de um conjunto de atributos.

Declaration

void ActualizaValorAtributos(int Ano, string Grupo, string Tipo, StdBECampos Atributos)

Parameters

Type	Name	Description
System.Int32	Ano
System.String	Grupo
System.String	Tipo
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, String)

Descrição associada ao grupo.

Declaration

string DaDescricao(int Ano, string Grupo, string Tipo)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Grupo	grupo.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas

Returns

Type	Description
System.String

DaListaElementos(Int32, String, String, String)

Devolve a listagem dos elementos de um grupo

Declaration

StdBELista DaListaElementos(int Ano, string Tipo, string Grupo, string Restricao = "")

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas
System.String	Grupo	grupo.
System.String	Restricao	Restrição para a lista de elementos.

Returns

Type	Description
StdBELista

DaListaGruposHierarquicos(Int32, String, String)

Devolve a listagem dos grupos

Declaration

StdBELista DaListaGruposHierarquicos(int Ano, string Tipo, string Restricao = "")

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas
System.String	Restricao	Restrição para a lista de grupos.

Returns

Type	Description
StdBELista

DaLstElementosMovimento(Int32, String, String)

Retorna uma lista com os elementos de movimento de toda a sub-árvore do Grupo.

Declaration

PrimaveraOrderedDictionary DaLstElementosMovimento(int Ano, string Grupo, string Tipo)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Grupo	grupo.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas

Returns

Type	Description
Primavera.Platform.Collections.PrimaveraOrderedDictionary

DaLstSubGrupos(Int32, String, String)

Devolve a listagem dos subgrupos de determinado grupo

Declaration

StdBELista DaLstSubGrupos(int Ano, string Grupo, string Tipo)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Grupo	grupo.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas

Returns

Type	Description
StdBELista

DaRaiz(Int32, String, String)

Retorna a raiz da arvore

Declaration

string DaRaiz(int Ano, string Grupo, string Tipo)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Grupo	grupo.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo.

Returns

Type	Description
System.String

DaValorAtributo(Int32, String, String, String)

Devolve o valor de um atributo.

Declaration

dynamic DaValorAtributo(int Ano, string Grupo, string Tipo, string Atributo)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Grupo	grupo.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

Type	Description
System.Object

DaValorAtributoLock(Int32, String, String, String)

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

Declaration

dynamic DaValorAtributoLock(int Ano, string Grupo, string Tipo, string Atributo)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Grupo	grupo.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

Type	Description
System.Object

DaValorAtributos(Int32, String, String, Object[])

Devolve o valor de um conjunto de atributos.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Grupo	grupo.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas
System.Object[]	Atributos	Conjunto de atributos dos quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosLock(Int32, String, String, Object[])

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

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Grupo	grupo.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas
System.Object[]	Atributos	Conjunto de atributos dos quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DesactivaHierarquia(Int32, String, String, Boolean)

Desactiva a hierarquia de uma dada raíz

Declaration

void DesactivaHierarquia(int Ano, string Tipo, string GrupoRaiz, bool blnActiva = false)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas
System.String	GrupoRaiz	grupo raíz da hierarquia.
System.Boolean	blnActiva	Para Activar/Desactivar hierarquia.

Edita(Int32, String, String)

Edita a informação do Grupo.

Declaration

CblBEGrupoHierarquico Edita(int Ano, string Grupo, string Tipo)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Grupo	grupo.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas

Returns

Type	Description
CblBEGrupoHierarquico

Existe(Int32, String, String)

Verifica se existe o Grupo.

Declaration

bool Existe(int Ano, string Grupo, string Tipo)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Grupo	grupo.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas

Returns

Type	Description
System.Boolean

ExisteHierarquia(Int32, String)

Verifica se existe uma hierarquia definida

Declaration

bool ExisteHierarquia(int Ano, string Tipo)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas

Returns

Type	Description
System.Boolean

InsereElemento(Int32, String, String, String, String)

Actualiza o elemento de grupo.

Declaration

void InsereElemento(int Ano, string Grupo, string Tipo, string Elemento, string SubElemento)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Grupo	grupo.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo.
System.String	Elemento	elemento.
System.String	SubElemento	Sub elemento: Usado quando temos Projectos PEP

Lstgrupos()

Devolve a listagem dos Grupos.

Declaration

StdBELista Lstgrupos()

Returns

Type	Description
StdBELista

Remove(Int32, String, String)

Remove o Grupo.

Declaration

void Remove(int Ano, string Grupo, string Tipo)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Grupo	grupo.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas

RemoveElemento(Int32, String, String, String, String)

Remove elemento do grupo.

Declaration

void RemoveElemento(int Ano, string Grupo, string Tipo, string Elemento, string SubElemento)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Grupo	grupo.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo.
System.String	Elemento	elemento.
System.String	SubElemento	SubElemento.

TemElementos(Int32, String, String)

Verifica se um dado grupo tem elementos

Declaration

bool TemElementos(int Ano, string Tipo, string Grupo)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas
System.String	Grupo	grupo.

Returns

Type	Description
System.Boolean

TemSubGrupos(Int32, String, String)

Verifica se um dado grupo tem subgrupos

Declaration

bool TemSubGrupos(int Ano, string Tipo, string Grupo)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas
System.String	Grupo	grupo.

Returns

Type	Description
System.Boolean

ValidaActualizacao(CblBEGrupoHierarquico, ref String)

Efectua a validação da informação do Grupo.

Declaration

bool ValidaActualizacao(CblBEGrupoHierarquico BEGrupo, ref string StrErro)

Parameters

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

Returns

Type	Description
System.Boolean

ValidaActualizacaoCabecalho(CblBEGrupoHierarquico, ref String)

Efectua a validação da informação do cabeçalho de um Grupo.

Declaration

bool ValidaActualizacaoCabecalho(CblBEGrupoHierarquico BEGrupo, ref string StrErro)

Parameters

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

Returns

Type	Description
System.Boolean

ValidaInsereElemento(Int32, String, String, String, String, ref String)

Efectua a validação do elemento.

Declaration

bool ValidaInsereElemento(int Ano, string Grupo, string Tipo, string Elemento, string SubElemento, ref string StrErro)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Grupo	grupo.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas
System.String	Elemento	elemento.
System.String	SubElemento
System.String	StrErro

Returns

Type	Description
System.Boolean

ValidaRemocao(Int32, String, String, ref String)

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

Declaration

bool ValidaRemocao(int Ano, string Grupo, string Tipo, ref string StrErro)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Grupo	grupo.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas
System.String	StrErro

Returns

Type	Description
System.Boolean

ValidaRemoveElemento(Int32, String, String, String, String, String)

Efectua a validação da remoção do elemento.

Declaration

bool ValidaRemoveElemento(int Ano, string Grupo, string Tipo, string Elemento, string SubElemento, string StrErro)

Parameters

Type	Name	Description
System.Int32	Ano	exercício.
System.String	Grupo	grupo.
System.String	Tipo	Tipo do grupo: A - actividades, C - Funções, O - Centros de Custo, F - Contas
System.String	Elemento	elemento.
System.String	SubElemento	SubElemento.
System.String	StrErro

Returns

Type	Description
System.Boolean