Interface ICblBSClassificacaoDocs

Esta classe deve ser usada para obter regras de negócio sobre a Classificação de Documentos

Namespace: ICblBS100

Assembly: ICblBS100.dll

Syntax

[ComVisible(true)]
[Guid("244D59C2-7937-40FA-9301-9519F472F0CD")]
public interface ICblBSClassificacaoDocs

Methods

Actualiza(CblBEClassificacaoDoc, String)

Actualiza a Operação na base de dados

Declaration

void Actualiza(CblBEClassificacaoDoc objBE, string strAvisos = "")

Parameters

Type	Name	Description
CblBEClassificacaoDoc	objBE	Objecto que identifica o ciclo de distribuição de custos a actualizar
System.String	strAvisos	Descrição dos avisos que possam surgir durante a actualização

ActualizaValorAtributo(String, String, Object)

Permite efectuar a actualização de um atributo de um determinada ciclo de distribuição de custos

Declaration

void ActualizaValorAtributo(string Classificacao, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	Classificacao
System.String	Atributo	Nome do campo a actualizar
System.Object	Valor	Valor do campo a actualizar

ActualizaValorAtributos(String, StdBECampos)

Permite efectuar a actualização de um conjunto de atributos de um determinado ciclo de distribuição de custos

Declaration

void ActualizaValorAtributos(string Classificacao, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	Classificacao
StdBECampos	Atributos	Atributos e respectivos valores a actualizar

DaColecaoClassificacoes()

Devolve uma colecção com as Classificações disponiveis

Declaration

PrimaveraOrderedDictionary DaColecaoClassificacoes()

Returns

Type	Description
Primavera.Platform.Collections.PrimaveraOrderedDictionary

DaDefCamposUtil()

Devolve as definições dos campos do utilizador da Operação

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

Type	Description
StdBEDefCamposUtil

DaDefCamposUtilLinhasClassificacaoDocumentos()

Devolve as definições dos campos do utilizador das linhas dos ciclos de distribuição de custos

Declaration

StdBEDefCamposUtil DaDefCamposUtilLinhasClassificacaoDocumentos()

Returns

Type	Description
StdBEDefCamposUtil

DaValorAtributo(String, String)

Devolve o valor de um determinado atributo do ciclo de dsitribuição de custos

Declaration

dynamic DaValorAtributo(string Classificacao, string Atributo)

Parameters

Type	Name	Description
System.String	Classificacao
System.String	Atributo	Atributo que se pretende obter o valor

Returns

Type	Description
System.Object

DaValorAtributoID(String, String)

Devolve o valor de um determinado atributo do ciclo de dsitribuição de custos

Declaration

dynamic DaValorAtributoID(string ID, string Atributo)

Parameters

Type	Name	Description
System.String	ID
System.String	Atributo	Atributo que se pretende obter o valor

Returns

Type	Description
System.Object

DaValorAtributoIDLock(String, String)

Devolve o valor de um determinado atributo do ciclo de dsitribuição de custos, respeitando os locks da base de dados.

Declaration

dynamic DaValorAtributoIDLock(string ID, string Atributo)

Parameters

Type	Name	Description
System.String	ID
System.String	Atributo	Atributo que se pretende obter o valor

Returns

Type	Description
System.Object

DaValorAtributoLock(String, String)

Devolve o valor de um determinado atributo do ciclo de dsitribuição de custos, respeitando os locks da base de dados.

Declaration

dynamic DaValorAtributoLock(string Classificacao, string Atributo)

Parameters

Type	Name	Description
System.String	Classificacao
System.String	Atributo	Atributo que se pretende obter o valor

Returns

Type	Description
System.Object

DaValorAtributos(String, Object[])

Devolve os valores de um conjunto de atributos do ciclo de distribuição de custos

Declaration

StdBECampos DaValorAtributos(string Classificacao, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.String	Classificacao
System.Object[]	Atributos	Atributos para os quais se pretende devolver os valores

Returns

Type	Description
StdBECampos

DaValorAtributosID(String, Object[])

Devolve os valores de um conjunto de atributos do ciclo de distribuição de custos

Declaration

StdBECampos DaValorAtributosID(string ID, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.String	ID
System.Object[]	Atributos	Atributos para os quais se pretende devolver os valores

Returns

Type	Description
StdBECampos

DaValorAtributosIDLock(String, Object[])

Devolve os valores de um conjunto de atributos do ciclo de distribuição de custos, respeitando os locks da base de dados.

Declaration

StdBECampos DaValorAtributosIDLock(string ID, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.String	ID
System.Object[]	Atributos	Atributos para os quais se pretende devolver os valores

Returns

Type	Description
StdBECampos

DaValorAtributosLock(String, Object[])

Devolve os valores de um conjunto de atributos do ciclo de distribuição de custos, respeitando os locks da base de dados.

Declaration

StdBECampos DaValorAtributosLock(string Classificacao, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.String	Classificacao
System.Object[]	Atributos	Atributos para os quais se pretende devolver os valores

Returns

Type	Description
StdBECampos

Edita(String)

Edita a informação associada a uma Classificação.

Declaration

CblBEClassificacaoDoc Edita(string Classificacao)

Parameters

Type	Name	Description
System.String	Classificacao	Código da Classificação.

Returns

Type	Description
CblBEClassificacaoDoc

EditaID(String)

Edita a informação associada a uma Classificação.

Declaration

CblBEClassificacaoDoc EditaID(string ID)

Parameters

Type	Name	Description
System.String	ID	Identificador da Classificação.

Returns

Type	Description
CblBEClassificacaoDoc

Existe(String)

Verifica se o ciclo de distribuição de custos existe na base de dados

Declaration

bool Existe(string Classificacao)

Parameters

Type	Name	Description
System.String	Classificacao	Código do ciclo de distribuição de custos

Returns

Type	Description
System.Boolean

ExisteID(String)

Verifica se o ciclo de distribuição de custos existe na base de dados

Declaration

bool ExisteID(string ID)

Parameters

Type	Name	Description
System.String	ID	Identificador da Classificação

Returns

Type	Description
System.Boolean

GeraSqlWhereCategoriaSubQuery()

Devolve uma string SQL com base nas condições existentes nos filtros da categoria de Classificação dos Documentos.

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 de Classificação dos Documentos.

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 de Classificação dos Documentos.

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 de Classificação dos Documentos.

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 de Classificação dos Documentos.

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 de Classificação dos Documentos.

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

LstClassificacaoDocumentos()

Devolve uma lista com as Classificações disponiveis

Declaration

StdBELista LstClassificacaoDocumentos()

Returns

Type	Description
StdBELista

Remove(String)

Remove toda a informação associada a uma Classificação Documental

Declaration

void Remove(string Classificacao)

Parameters

Type	Name	Description
System.String	Classificacao	Código da Classificação

RemoveID(String)

Remove toda a informação associada a uma Classificação Documental

Declaration

void RemoveID(string ID)

Parameters

Type	Name	Description
System.String	ID	Identificador da Classificação

ValidaActualizacao(CblBEClassificacaoDoc, ref String)

Efectua as validações necessárias à actualização de um ciclo de distribuição de custos

Declaration

bool ValidaActualizacao(CblBEClassificacaoDoc objBE, ref string ErroValidacao)

Parameters

Type	Name	Description
CblBEClassificacaoDoc	objBE	Objecto que identifica o ciclo de distribuição de custos a validar
System.String	ErroValidacao	Descrição de erro devolvida pela função

Returns

Type	Description
System.Boolean

ValidaOperacaoCategoria(String, ref String, Int32)

Devolve se o utilizador actual tem acesso a uma determinada Classificação de Documentos, analisando os filtros da categoria.

Declaration

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

Parameters

Type	Name	Description
System.String	Classificacao	Classificação.
System.String	MsgErro
System.Int32	Linha	Número da linha.

Returns

Type	Description
System.Boolean

ValidaRemocao(String, ref String)

Efectua as validações necessárias à remoção da Classificação de Documento

Declaration

bool ValidaRemocao(string Classificacao, ref string ErroValidacao)

Parameters

Type	Name	Description
System.String	Classificacao	Codigo da classificação
System.String	ErroValidacao	Descrição de erro devolvida pela função

Returns

Type	Description
System.Boolean

ValidaRemocaoID(String, String)

Efectua as validações necessárias à remoção da Classificação de Documento

Declaration

bool ValidaRemocaoID(string ID, string ErroValidacao)

Parameters

Type	Name	Description
System.String	ID
System.String	ErroValidacao	Descrição de erro devolvida pela função

Returns

Type	Description
System.Boolean