Class StdBSCategorias
Serviços de gestão de categorias de informação.
Inheritance
Implements
Inherited Members
Namespace: StdPlatBS100
Assembly: StdPlatBS100.dll
Syntax
[ComVisible(true)]
[Guid("91BA0BAB-6DDE-4EC0-B3F4-F9B4C282F058")]
[ClassInterface(ClassInterfaceType.None)]
public class StdBSCategorias : IStdBSCategorias
Properties
Categorias
Devolve as categorias.
Declaration
public StdBESqlCategorias Categorias { get; }
Property Value
Type | Description |
---|---|
StdBESql100.StdBESqlCategorias |
ProgressoCategorias
Indica se o progresso de carregamento das categorias está activo.
Declaration
public bool ProgressoCategorias { set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Tabelas
Devolve as tabelas.
Declaration
public StdBESqlTabelas Tabelas { get; }
Property Value
Type | Description |
---|---|
StdBESql100.StdBESqlTabelas |
Methods
AbreListaCategoria(String)
Abre a lista por defeito associada a uma determinada categoria.
Declaration
public void AbreListaCategoria(string strCategoria)
Parameters
Type | Name | Description |
---|---|---|
System.String | strCategoria | Identificador da categoria. |
AbreListaCategoriaParametros(String, StdBEValoresStr)
Abre a lista por defeito associada a uma determinada categoria,filtrando a lista com os parâmetros indicados.
Declaration
public void AbreListaCategoriaParametros(string strCategoria, StdBEValoresStr objParametros)
Parameters
Type | Name | Description |
---|---|---|
System.String | strCategoria | Identificador da categoria. |
StdBEValoresStr | objParametros | Parametrização da categoria. |
AbreListaCategoriaWhere(String, String, Boolean, String)
Abre a lista por defeito associada a uma determinada categoria,filtrando a lista com os parâmetros indicados.
Declaration
public void AbreListaCategoriaWhere(string strCategoria, string strClausulaWhere, bool blnModal, string strQueryGuid = "")
Parameters
Type | Name | Description |
---|---|---|
System.String | strCategoria | Identificador da categoria. |
System.String | strClausulaWhere | Filtro aplicado à categoria. |
System.Boolean | blnModal | Abre a lista em modo modal. |
System.String | strQueryGuid | Query GUID. |
AbreListaSQL(String, String, StdBEF4, Boolean)
Abre uma lista com os resultados da query SQL.
Declaration
public void AbreListaSQL(string strQuerySQL, string strTitulo, StdBEF4 objF4Ctrl = null, bool blnJanelaModal = false)
Parameters
Type | Name | Description |
---|---|---|
System.String | strQuerySQL | Query SQL a executar. |
System.String | strTitulo | Título da janela. |
StdBEF4 | objF4Ctrl | |
System.Boolean | blnJanelaModal | Janela modal. |
ActualizaQuery(StdBESqlQuery)
Actualiza Query.
Declaration
public void ActualizaQuery(StdBESqlQuery objQuery)
Parameters
Type | Name | Description |
---|---|---|
StdBESql100.StdBESqlQuery | objQuery | Objecto com as definições do Query. |
carregaFiltroCategorias(StdBESqlQuery)
Carrega o filtro de uma categoria para uma query SQL.
Declaration
public void carregaFiltroCategorias(StdBESqlQuery objQuery)
Parameters
Type | Name | Description |
---|---|---|
StdBESql100.StdBESqlQuery | objQuery | Definição da query SQL. |
CategoriasExpressoes(String, String)
Devolve a expressão de uma categoria.
Declaration
public StdBESqlExpressao CategoriasExpressoes(string strCategoria, string GUID = "")
Parameters
Type | Name | Description |
---|---|---|
System.String | strCategoria | Nome da categoria. |
System.String | GUID | Identificador da categoria. |
Returns
Type | Description |
---|---|
StdBESql100.StdBESqlExpressao |
CriaNovaLista(String)
Criação da definição de uma nova lista para uma determinada categoria.
Declaration
public StdBESqlQuery CriaNovaLista(string Categoria)
Parameters
Type | Name | Description |
---|---|---|
System.String | Categoria | Identificador da categoria. |
Returns
Type | Description |
---|---|
StdBESql100.StdBESqlQuery |
DaIdQueryPorDefeito(String)
Devolve o identificador da lista por defeito de uma categoria.
Declaration
public string DaIdQueryPorDefeito(string Categoria)
Parameters
Type | Name | Description |
---|---|---|
System.String | Categoria | Identificador da categoria. |
Returns
Type | Description |
---|---|
System.String |
DaQuery(String)
Devolve a definição de uma lista.
Declaration
public StdBESqlQuery DaQuery(string GuidQuery)
Parameters
Type | Name | Description |
---|---|---|
System.String | GuidQuery | Identificador da lista. |
Returns
Type | Description |
---|---|
StdBESql100.StdBESqlQuery |
DaQueryPorDefeito(String, StdBESqlQueries)
Devolve a definição da lista por defeito de uma categoria.
Declaration
public StdBESqlQuery DaQueryPorDefeito(string Categoria, StdBESqlQueries Queries)
Parameters
Type | Name | Description |
---|---|---|
System.String | Categoria | Identificador da categoria. |
StdBESql100.StdBESqlQueries | Queries | Colecção de todas as listas existentes para a categoria indicada. |
Returns
Type | Description |
---|---|
StdBESql100.StdBESqlQuery |
DaTabelaPrimaria(String)
Devolve a definição da tabela principal de uma categoria.
Declaration
public StdBESqlTabela DaTabelaPrimaria(string Categoria)
Parameters
Type | Name | Description |
---|---|---|
System.String | Categoria | Identificador da categoria. |
Returns
Type | Description |
---|---|
StdBESql100.StdBESqlTabela |
EditaLista(StdBESqlQuery, Boolean)
Abre o formulário de edição de uma lista.
Declaration
public bool EditaLista(StdBESqlQuery objQuery, bool blnGravaAlteracoes = true)
Parameters
Type | Name | Description |
---|---|---|
StdBESql100.StdBESqlQuery | objQuery | Definição da lista a editar. |
System.Boolean | blnGravaAlteracoes | Indica se as alterações efectuadas devem ser gravadas no sistema. |
Returns
Type | Description |
---|---|
System.Boolean |
EditaQuery(String)
Edita o Query.
Declaration
public StdBESqlQuery EditaQuery(string strIdQuery)
Parameters
Type | Name | Description |
---|---|---|
System.String | strIdQuery | Identificador do Query. |
Returns
Type | Description |
---|---|
StdBESql100.StdBESqlQuery |
ExisteQuery(String)
Verifica se existe o query.
Declaration
public bool ExisteQuery(string strIdQuery)
Parameters
Type | Name | Description |
---|---|---|
System.String | strIdQuery | Identificador do Id do Query. |
Returns
Type | Description |
---|---|
System.Boolean |
FiltroCategoria(String)
Devolve o filtro de uma categoria.
Declaration
public string FiltroCategoria(string Categoria)
Parameters
Type | Name | Description |
---|---|---|
System.String | Categoria | Nome da categoria. |
Returns
Type | Description |
---|---|
System.String |
FiltroPersonalizado(String, Boolean)
Devolve o filtro personalizado de uma categoria.
Declaration
public string FiltroPersonalizado(string strCategoria, bool blnFormatacaoMapas = false)
Parameters
Type | Name | Description |
---|---|---|
System.String | strCategoria | Nome da categoria. |
System.Boolean | blnFormatacaoMapas | Formatação para Mapas. |
Returns
Type | Description |
---|---|
System.String |
Finalize()
Declaration
protected void Finalize()
GeraSql(StdBESqlQuery, Boolean, List<String>)
Devolve a instrução SQL resultante da definição de uma lista.
Declaration
public string GeraSql(StdBESqlQuery objQuery, bool blnPreencheParametros = true, List<string> listParameters = null)
Parameters
Type | Name | Description |
---|---|---|
StdBESql100.StdBESqlQuery | objQuery | Definição da lista. |
System.Boolean | blnPreencheParametros | Indica se, caso a lista tenha parâmetros dinâmicos, estes devem ser solicitados ao utilizador e preenchidos no resultado. |
System.Collections.Generic.List<System.String> | listParameters |
Returns
Type | Description |
---|---|
System.String |
GeraSqlFrom(StdBESqlQuery)
Devolve a definição da clausula FROM da instrução SQL resultante da execução de uma lista.
Declaration
public string GeraSqlFrom(StdBESqlQuery objQuery)
Parameters
Type | Name | Description |
---|---|---|
StdBESql100.StdBESqlQuery | objQuery | Definição da lista. |
Returns
Type | Description |
---|---|
System.String |
GeraSqlFromCategoria(String)
Devolve a definição da clausula FROM da instrução SQL resultante da execução de uma lista.
Declaration
public string GeraSqlFromCategoria(string strCategoria)
Parameters
Type | Name | Description |
---|---|---|
System.String | strCategoria | Definição da lista. |
Returns
Type | Description |
---|---|
System.String |
GeraSqlFromCategoriaExpressao(String, StdBESqlExpressao)
Devolve a definição da clausula FROM da instrução SQL resultante da execução de uma lista.
Declaration
public string GeraSqlFromCategoriaExpressao(string strCategoria, StdBESqlExpressao objExpressao)
Parameters
Type | Name | Description |
---|---|---|
System.String | strCategoria | Categoria. |
StdBESql100.StdBESqlExpressao | objExpressao | expressão para a qual vai ser gerado o from. |
Returns
Type | Description |
---|---|
System.String |
GeraSqlGroupBy(StdBESqlQuery)
Devolve a definição da clausula GroupBy da instrução SQL resultante da execução de uma lista.
Declaration
public string GeraSqlGroupBy(StdBESqlQuery objQuery)
Parameters
Type | Name | Description |
---|---|---|
StdBESql100.StdBESqlQuery | objQuery | Definição da lista. |
Returns
Type | Description |
---|---|
System.String |
GeraSqlHaving(StdBESqlQuery)
Devolve a definição da clausula Having da instrução SQL resultante da execução de uma lista.
Declaration
public string GeraSqlHaving(StdBESqlQuery objQuery)
Parameters
Type | Name | Description |
---|---|---|
StdBESql100.StdBESqlQuery | objQuery | Definição da lista. |
Returns
Type | Description |
---|---|
System.String |
GeraSqlOrder(StdBESqlQuery)
Devolve a definição da clausula ORDER BY da instrução SQL resultante da execução de uma lista.
Declaration
public string GeraSqlOrder(StdBESqlQuery objQuery)
Parameters
Type | Name | Description |
---|---|---|
StdBESql100.StdBESqlQuery | objQuery | Definição da lista. |
Returns
Type | Description |
---|---|
System.String |
GeraSqlSelect(StdBESqlQuery)
Devolve a definição da clausula SELECT da instrução SQL resultante da execução de uma lista.
Declaration
public string GeraSqlSelect(StdBESqlQuery objQuery)
Parameters
Type | Name | Description |
---|---|---|
StdBESql100.StdBESqlQuery | objQuery | Definição da lista. |
Returns
Type | Description |
---|---|
System.String |
GeraSqlWhere(StdBESqlQuery, Boolean, List<String>)
Devolve a definição da clausula WHERE da instrução SQL resultante da execução de uma lista.
Declaration
public string GeraSqlWhere(StdBESqlQuery objQuery, bool blnPreencheParametros = true, List<string> listParameters = null)
Parameters
Type | Name | Description |
---|---|---|
StdBESql100.StdBESqlQuery | objQuery | Definição da lista. |
System.Boolean | blnPreencheParametros | Devolve a instrução SQL resultante da definição de uma lista. |
System.Collections.Generic.List<System.String> | listParameters |
Returns
Type | Description |
---|---|
System.String |
GeraSqlWhereCategoria(String, String, Boolean)
Devolve a definição da clausula WHERE da instrução SQL para uma determinada categoria.
Declaration
public string GeraSqlWhereCategoria(string strCategoria, string strUtilizador, bool blnFormatacaoMapas = false)
Parameters
Type | Name | Description |
---|---|---|
System.String | strCategoria | Categoria. |
System.String | strUtilizador | Nome do Utilzador. |
System.Boolean | blnFormatacaoMapas | Formatação para Mapas. |
Returns
Type | Description |
---|---|
System.String |
GeraSqlWhereCategoriaFiltro(String, String, String, String, String, StdBESqlFiltroPersonalizado, Boolean)
Gera o filtro Where completo, para uma categoria.
Declaration
public string GeraSqlWhereCategoriaFiltro(string strTabelaPrincipal, string strCampoPrincipal, string strTabelaFiltro, string strCampoFiltro, string strCategoria, StdBESqlFiltroPersonalizado objFiltro, bool blnMapeamentos = true)
Parameters
Type | Name | Description |
---|---|---|
System.String | strTabelaPrincipal | Tabela Principal. |
System.String | strCampoPrincipal | Campo Principal. |
System.String | strTabelaFiltro | Tabela usada para o filtro. |
System.String | strCampoFiltro | Campo usado para filtro. |
System.String | strCategoria | Categoria. |
StdBESql100.StdBESqlFiltroPersonalizado | objFiltro | Filtro. |
System.Boolean | blnMapeamentos | AplicarMapeamentos. |
Returns
Type | Description |
---|---|
System.String |
GeraSqlWhereCategoriaSubQuery(String, String, String, String, String, String)
Gera o filtro Where completo, para uma categoria.
Declaration
public string GeraSqlWhereCategoriaSubQuery(string strTabelaPrincipal, string strCampoPrincipal, string strTabelaFiltro, string strCampoFiltro, string strCategoria, string strUtilizador = "")
Parameters
Type | Name | Description |
---|---|---|
System.String | strTabelaPrincipal | Tabela Principal. |
System.String | strCampoPrincipal | Campo Principal. |
System.String | strTabelaFiltro | Tabela usada para o filtro. |
System.String | strCampoFiltro | Campo usado para filtro. |
System.String | strCategoria | Categoria. |
System.String | strUtilizador | Utilizador. |
Returns
Type | Description |
---|---|
System.String |
GeraSqlWhereEx(StdBESqlQuery, Boolean)
Devolve a definição da clausula WHERE da instrução SQL resultante da execução de uma lista.
Declaration
public string GeraSqlWhereEx(StdBESqlQuery objQuery, bool blnPreencheParametros = true)
Parameters
Type | Name | Description |
---|---|---|
StdBESql100.StdBESqlQuery | objQuery | Definição da lista. |
System.Boolean | blnPreencheParametros | Devolve a instrução SQL resultante da definição de uma lista. |
Returns
Type | Description |
---|---|
System.String |
ListaQueriesAdHocPublicas(ref String[,], Object, String)
Preenche um controlo com a colecção de listas AdHoc de uma determinada categoria.
Declaration
public bool ListaQueriesAdHocPublicas(ref string[, ] strQueries, object objControlo = null, string strSelectQueryGuid = "")
Parameters
Type | Name | Description |
---|---|---|
System.String[,] | strQueries | Lista de identificadores das categorias. |
System.Object | objControlo | Controlo (ComboBox, ListBox, ListView ou ActiveBar2.Band) que será carregado com a colecção de listas. |
System.String | strSelectQueryGuid | Identificador da lista que deve ser seleccionada (no controlo) por defeito. |
Returns
Type | Description |
---|---|
System.Boolean |
ListaQueriesComFiltroPorCategoria(String, ref String[,], Object, String)
Devolve uma colecção das listas associadas a uma categoria e preenche um controlo com os resultados.
Declaration
public bool ListaQueriesComFiltroPorCategoria(string Categoria, ref string[, ] Queries, dynamic Controlo = null, string SelectQueryGuid = "")
Parameters
Type | Name | Description |
---|---|---|
System.String | Categoria | Identificador da categoria. |
System.String[,] | Queries | Array com os identificadores e descrições de todas as listas resultantes. |
System.Object | Controlo | Controlo(ComboBox, ListBox, ListView ou ActiveBar2.Band) que deve ser preenchido com as listas resultantes. |
System.String | SelectQueryGuid | Identificador da lista que deve ser seleccionada (no controlo) por defeito. |
Returns
Type | Description |
---|---|
System.Boolean |
ListaQueriesPorCategoria(String, ref String[,], Object, String)
Preenche um controlo com a colecção de listas de uma determinada categoria.
Declaration
public bool ListaQueriesPorCategoria(string Categoria, ref string[, ] Queries, object Controlo = null, string SelectQueryGuid = "")
Parameters
Type | Name | Description |
---|---|---|
System.String | Categoria | Identificador da categoria. |
System.String[,] | Queries | Array resultado com os identificadores e descrições das listas. |
System.Object | Controlo | Controlo (ComboBox, ListBox, ListView ou ActiveBar2.Band) que será carregado com a colecção de listas. |
System.String | SelectQueryGuid | Identificador da lista que deve ser seleccionada (no controlo) por defeito. |
Returns
Type | Description |
---|---|
System.Boolean |
ListaQueriesPorCategoriaEx(String, ref String[,], Object, String)
Preenche um controlo com a colecção de listas de uma determinada categoria.
Declaration
public bool ListaQueriesPorCategoriaEx(string Categoria, ref string[, ] Queries, object Controlo = null, string SelectQueryGuid = "")
Parameters
Type | Name | Description |
---|---|---|
System.String | Categoria | Identificador da categoria. |
System.String[,] | Queries | Array resultado com os identificadores e descrições das listas. |
System.Object | Controlo | Controlo (ComboBox, ListBox, ListView ou ActiveBar2.Band) que será carregado com a colecção de listas. |
System.String | SelectQueryGuid | Identificador da lista que deve ser seleccionada por defeito (no controlo). |
Returns
Type | Description |
---|---|
System.Boolean |
ListaQueriesPublicasPorCategoria(String, ref String[,], Object, String)
Preenche um controlo com a colecção de listas publicas de uma determinada categoria.
Declaration
public bool ListaQueriesPublicasPorCategoria(string strCategoria, ref string[, ] strQueries, object objControlo = null, string strSelectQueryGuid = "")
Parameters
Type | Name | Description |
---|---|---|
System.String | strCategoria | Identificador da categoria. |
System.String[,] | strQueries | Array resultado com os identificadores e descrições das listas. |
System.Object | objControlo | Controlo (ComboBox, ListBox, ListView ou ActiveBar2.Band) que será carregado com a colecção de listas. |
System.String | strSelectQueryGuid | Identificador da lista que deve ser seleccionada (no controlo) por defeito. |
Returns
Type | Description |
---|---|
System.Boolean |
ListasCarregaCategorias(Boolean, Boolean)
Carrega categorias.
Declaration
public StdBEValoresStr ListasCarregaCategorias(bool blnTodas, bool blnSQL)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | blnTodas | Todas as categorias. |
System.Boolean | blnSQL | Categorias SQL. |
Returns
Type | Description |
---|---|
StdBEValoresStr |
ParseCamposAutomaticos(ref String)
Devolve o valor de um parâmetro de contexto das listas (ex.: %%EMPMOEDABASE%%).
Declaration
public string ParseCamposAutomaticos(ref string strValue)
Parameters
Type | Name | Description |
---|---|---|
System.String | strValue | Valor a traduzir. |
Returns
Type | Description |
---|---|
System.String |
ParseCamposAutomaticosEx2(ref String)
Faz o parse a campos automáticos.
Declaration
public string ParseCamposAutomaticosEx2(ref string strValue)
Parameters
Type | Name | Description |
---|---|---|
System.String | strValue | Valor. |
Returns
Type | Description |
---|---|
System.String |
TestaPermissaoLista(String, String, String, Boolean, StdBETipos.TipoPermissaoListas, Boolean)
Verifica se o utilizador actual tem permissões para aceder a uma determinada lista.
Declaration
public bool TestaPermissaoLista(string strCategoria, string strIdLista, string strCriadorLista, bool blnListaSistema, StdBETipos.TipoPermissaoListas enuTipoPermissao, bool blnSilencioso = false)
Parameters
Type | Name | Description |
---|---|---|
System.String | strCategoria | Identificador da categoria. |
System.String | strIdLista | Identificador da lista. |
System.String | strCriadorLista | Identificador do utilizador que criou a lista. |
System.Boolean | blnListaSistema | Indica se a lista a verificar é de sistema. |
StdBETipos.TipoPermissaoListas | enuTipoPermissao | Tipo de permissão a validar. |
System.Boolean | blnSilencioso | Indica se devem ser apresentadas mensagens ao utilizador (caso não tenha permissões). |
Returns
Type | Description |
---|---|
System.Boolean |
ValidaEdicao(String, String, String, String)
Valida a edição de uma Categoria.
Declaration
public bool ValidaEdicao(string strCategoria, string strTabela, string strCampo, string strChave)
Parameters
Type | Name | Description |
---|---|---|
System.String | strCategoria | Nome da categoria. |
System.String | strTabela | Nome da tabela. |
System.String | strCampo | Nome do campo. |
System.String | strChave | Chave. |
Returns
Type | Description |
---|---|
System.Boolean |
ValidaEdicaoRegisto(String, String, String, Object[])
Valida a edição de uma Categoria.
Declaration
public bool ValidaEdicaoRegisto(string Categoria, string Tabela, string Campo, params object[] Chaves)
Parameters
Type | Name | Description |
---|---|---|
System.String | Categoria | Nome da categoria. |
System.String | Tabela | Nome da tabela. |
System.String | Campo | Nome dos campos separados por ','. |
System.Object[] | Chaves | Chaves. |
Returns
Type | Description |
---|---|
System.Boolean |
ValidaOperacao(String, String, String, String)
Valida uma operacao sobre uma Categoria.
Declaration
public bool ValidaOperacao(string strCategoria, string strTabela, string strCampo, string strChave)
Parameters
Type | Name | Description |
---|---|---|
System.String | strCategoria | Nome da categoria. |
System.String | strTabela | Nome da tabela. |
System.String | strCampo | Nome do campo. |
System.String | strChave | Chave. |
Returns
Type | Description |
---|---|
System.Boolean |
ValidaOperacaoRegisto(String, String, String, Object[])
Valida a uma operação sobre de uma Categoria.
Declaration
public bool ValidaOperacaoRegisto(string Categoria, string Tabela, string Campo, params object[] Chaves)
Parameters
Type | Name | Description |
---|---|---|
System.String | Categoria | Nome da categoria. |
System.String | Tabela | Nome da tabela. |
System.String | Campo | Nome dos campos separados por ','. |
System.Object[] | Chaves | Chaves. |
Returns
Type | Description |
---|---|
System.Boolean |
VerificaExisteCollection(String, PrimaveraOrderedDictionary)
Verifica se uma chave existe numa collection.
Declaration
public bool VerificaExisteCollection(string strKey, PrimaveraOrderedDictionary Collection)
Parameters
Type | Name | Description |
---|---|---|
System.String | strKey | Chave. |
Primavera.Platform.Collections.PrimaveraOrderedDictionary | Collection | Collection. |
Returns
Type | Description |
---|---|
System.Boolean |