Classe TKernelPesquisa

Unit

untKernelPesquisa

Declaração

type TKernelPesquisa = class(TObject)

Descrição

Implementação da entidade de pesquisas

Hierarquia

TObject
TKernelPesquisa

Visão Geral

Campos

	`clsClasseEntidadePesquisa: TEntidadeClasse;`
	`objEntidadePesquisa: TdtmKernelComum;`
	`objEntidadePai: TdtmKernelComum;`
	`objBotaoEditar: TSpeedButton;`
	`objBotaoNovo: TSpeedButton;`
	`FEventoAposConfirmarPesquisa: TEventoAposConfirmarPesquisa;`
	`FEventoAntesDeConfirmarPesquisa: TEventoAntesDeConfirmarPesquisa;`
	`FEventoFiltroCallback: TEventoFiltroCallback;`
	`lstRetorno: TList;`
	`objMestre: TKernelPesquisa;`
	`bolSomenteLeitura: boolean;`

Métodos

	`procedure DefinirBotaoEditar(const objBotao : TSpeedButton);`
	`procedure DefinirBotaoNovo(const objBotao : TSpeedButton);`
	`procedure BotaoNovoAoClicar(Sender : TObject);`
	`procedure BotaoEditarAoClicar(Sender : TObject);`
	`procedure NovoManutencao;`
	`procedure AbrirManutencao;`
	`procedure AtualizarBotaoEditar;`
	`procedure AtualizarBotaoNovo;`
	`function ObterFiltroFiltro: string;`
	`procedure DefinirObjetoMestre(const Value: TKernelPesquisa);`
	`procedure AposAtualizarPesquisa;`
	`procedure DefinirSomenteLeitura(const Value: boolean);`
	`function ObterSomenteLeitura: boolean;`
	`procedure InstanciarPesquisa; virtual;`
	`procedure AposInstanciarEntidadePesquisa; virtual;`
	`procedure DefinirClassePesquisa(const clsEntidade : TEntidadeClasse); virtual;`
	`procedure AtualizarValores;`
	`procedure AtualizarValoresInterno; virtual; abstract;`
	`function ObterCodigo : string; virtual; abstract;`
	`function ObterNome : string; virtual; abstract;`
	`function VerificarSomenteLeitura : boolean; virtual;`
	`procedure AtualizarPesquisaInterno; virtual;`
	`procedure AtualizarSomenteLeituraInterno; virtual;`
	`constructor Create(const EntidadePai : TdtmKernelComum); virtual;`
	`destructor Destroy; override;`
	`procedure AtualizarPesquisa;`
	`procedure NovoRetorno(const objCaixa : TCustomEdit; const strNomeCampoRetorno : string; const strNomeCampoDestino : string = '');`
	`procedure AtualizarSomenteLeitura;`

Properties

	`property ClasseEntidade : TEntidadeClasse write DefinirClassePesquisa;`
	`property BotaoNovo : TSpeedButton write DefinirBotaoNovo;`
	`property BotaoEditar : TSpeedButton write DefinirBotaoEditar;`
	`property EventoAposConfirmarPesquisa : TEventoAposConfirmarPesquisa read FEventoAposConfirmarPesquisa write FEventoAposConfirmarPesquisa;`
	`property EventoAntesDeConfirmarPesquisa : TEventoAntesDeConfirmarPesquisa read FEventoAntesDeConfirmarPesquisa write FEventoAntesDeConfirmarPesquisa;`
	`property FiltroCallback : TEventoFiltroCallback read FEventoFiltroCallback write FEventoFiltroCallback;`
	`property Filtro : string read ObterFiltroFiltro;`
	`property ObjetoMestre : TKernelPesquisa write DefinirObjetoMestre;`
	`property EntidadePesquisa : TEntidade read objEntidadePesquisa;`
	`property SomenteLeitura : boolean read ObterSomenteLeitura write DefinirSomenteLeitura;`

Descrição

Campos

	`clsClasseEntidadePesquisa: TEntidadeClasse;`
Classe da Entidade a pesquisar

	`objEntidadePesquisa: TdtmKernelComum;`
Objeto da Entidade de Pesquisa

	`objEntidadePai: TdtmKernelComum;`
Objeto da Entidade Pai

	`objBotaoEditar: TSpeedButton;`
Botão para controle da manutenção do registro selecionado

	`objBotaoNovo: TSpeedButton;`
Botão para criar um novo registro na entidade

	`FEventoAposConfirmarPesquisa: TEventoAposConfirmarPesquisa;`
Evento disparado após pesquisar

	`FEventoAntesDeConfirmarPesquisa: TEventoAntesDeConfirmarPesquisa;`
Evento chamado antes de confirmar a pesquisa, permite validar se pode ou não continuar e definir os valores

	`FEventoFiltroCallback: TEventoFiltroCallback;`
Evento de Callback para retornar um filtro para a pesquisa

	`lstRetorno: TList;`
Lista para controlar os controles extras de lookup

	`objMestre: TKernelPesquisa;`
Permite definir um objeto mestre de pesquisa para criar pesquisas em forma mestre-detalhe (é necessário que as entidades que fazem parte da pesquisa também sejam um mestre-detalhe)

	`bolSomenteLeitura: boolean;`
Determina se o controlador está em modo somente leitura

Métodos

	`procedure DefinirBotaoEditar(const objBotao : TSpeedButton);`
Evento disparado antes de confirmar a pesquisa Definição do Botão de Edição do registro selecionado

	`procedure DefinirBotaoNovo(const objBotao : TSpeedButton);`
Definição do Botão para criar um novo registro na entidade selecionada

	`procedure BotaoNovoAoClicar(Sender : TObject);`
Ação a ser executada ao clicar no botão de Novo

	`procedure BotaoEditarAoClicar(Sender : TObject);`
Ação a ser executada ao clicar no botão de editar

	`procedure NovoManutencao;`
Método executado ao clicar no botão para inserir um novo registro na entidade

	`procedure AbrirManutencao;`
Método executado ao clicar no botão para editar o registro na entidade

	`procedure AtualizarBotaoEditar;`
Atualiza as configurações do botão editar

	`procedure AtualizarBotaoNovo;`
Atualiza as configurações do botão novo

	`function ObterFiltroFiltro: string;`
Obtém o Filtro da funçào de callback

procedure DefinirObjetoMestre(const Value: TKernelPesquisa);

Define o objeto mestre da pesquisa

Parâmetros

Value: Objeto Mestre a ser definido

	`procedure AposAtualizarPesquisa;`
Evento após a atualização da pesquisa

procedure DefinirSomenteLeitura(const Value: boolean);

Define a pesquisa como somente leirura

Parâmetros

Value: Definir sim ou não leitura

	`function ObterSomenteLeitura: boolean;`
Retorna verdadeiro caso seja somente leitura

	`procedure InstanciarPesquisa; virtual;`
Instancia a Classe a ser pesquisada

	`procedure AposInstanciarEntidadePesquisa; virtual;`
Evendo Disparado após instanciar a entidade de pesquisa

	`procedure DefinirClassePesquisa(const clsEntidade : TEntidadeClasse); virtual;`
Definição da Classe de Pesquisa

	`procedure AtualizarValores;`
Atualiza os valores das caixas de pesquisa

	`procedure AtualizarValoresInterno; virtual; abstract;`
Atualiza os valores das caixas de pesquisa

	`function ObterCodigo : string; virtual; abstract;`
Retorna o código a para abrir a manutenção Para pesquisa na entidade, retorna o código da caixa de texto Para pesquisa em combobox, retorna o ID atual

	`function ObterNome : string; virtual; abstract;`
Retorna o código a para abrir a manutenção Para pesquisa na entidade, retorna o nome da caixa de texto Para pesquisa em combobox, retorna o nome atual

	`function VerificarSomenteLeitura : boolean; virtual;`
Verifica se a entidade inicializa ou não como somente leitura

	`procedure AtualizarPesquisaInterno; virtual;`
Atualiza os controladores da pesquisa

	`procedure AtualizarSomenteLeituraInterno; virtual;`
Atualiza as propriedades dos componentes somente leitura

	`constructor Create(const EntidadePai : TdtmKernelComum); virtual;`
Construtor da Classe

	`destructor Destroy; override;`
Destrutor

	`procedure AtualizarPesquisa;`
Atualiza os controladores da pesquisa

	`procedure NovoRetorno(const objCaixa : TCustomEdit; const strNomeCampoRetorno : string; const strNomeCampoDestino : string = '');`
Cria um novo controlador de campo interno para retornar um valor extra da entidade pesquisada

	`procedure AtualizarSomenteLeitura;`
Atualiza a posição de somente leitura, dos campos, edits, etc

Properties

	`property ClasseEntidade : TEntidadeClasse write DefinirClassePesquisa;`
Propriedade de acesso à Classe a Pesquisar

	`property BotaoNovo : TSpeedButton write DefinirBotaoNovo;`
Propriedade de acesso ao Botão de Novo

	`property BotaoEditar : TSpeedButton write DefinirBotaoEditar;`
Propriedade de acesso ao Botão de Editar

	`property EventoAposConfirmarPesquisa : TEventoAposConfirmarPesquisa read FEventoAposConfirmarPesquisa write FEventoAposConfirmarPesquisa;`
Evento disparado após confirmar os valores da pesquisa

	`property EventoAntesDeConfirmarPesquisa : TEventoAntesDeConfirmarPesquisa read FEventoAntesDeConfirmarPesquisa write FEventoAntesDeConfirmarPesquisa;`
Evento disparado antes de confirmar os valores da pesquisa, para efetuar a validação

	`property FiltroCallback : TEventoFiltroCallback read FEventoFiltroCallback write FEventoFiltroCallback;`
Evento de Callback para Obter o Filtro para a pesquisa

	`property Filtro : string read ObterFiltroFiltro;`
Determina um filtro a ser utilizado na consulta

	`property ObjetoMestre : TKernelPesquisa write DefinirObjetoMestre;`
Objeto mestre a pesquisa

	`property EntidadePesquisa : TEntidade read objEntidadePesquisa;`
Entidad de pesquisa

	`property SomenteLeitura : boolean read ObterSomenteLeitura write DefinirSomenteLeitura;`
Define/Verifica se a pesquisa está somente definida como leitura

Autor

Carlos Antonio da Silva

Criada

Data: 15 de outubro de 2005