Programa Retorno Externo

Objetivo	Permitir o auxílio na construção de métodos do programa de retorno externo.
Programa	SOEXP001
Pré-Requisito	É pré-requisito para a execução dessa função: Função Propriedades dos Objetos (SO701)
Visão Geral	Por intermédio dessa função é possível criar métodos de retorno externo com base no valor do objeto selecionado e com base também nos valores dos outros objetos da tela.

Descrição

Programa de Retorno Externo

O programa de retorno externo é utilizado para especificar uma validação ou verificação conforme a necessidade do usuário.

Atualmente é possível utilizar retorno externo para as seguintes propriedades:

Condição: onde deve retornar YES para indicar que um botão deve ficar desabilitado/escondido.
Lista de Valores: onde deve retornar NO para indicar que o usuário não pode incluir, modificar, eliminar, etc.
Valor Inicial: onde deve retornar o valor para inicialização do objeto correspondente (caracter).

O programa de retorno externo é composto de um ou mais métodos construídos pelo usuário administrador, com o objetivo de verificar uma condição ou uma validação específica de um objeto.

Segue abaixo o protótipo de definição de um Programa de Retorno Externo:

/********************************************************************************
** Copyright DATASUL S.A. (1997)
** Todos os Direitos Reservados.
**
** Este fonte e de propriedade exclusiva da DATASUL, sua reproducao
** parcial ou total por qualquer meio, so podera ser feita mediante
** autorizacao expressa.
*******************************************************************************/
/*******************************************************************************
**   Programa..: sop/soexp001.P
**   Objetivo..: Retorno Externo para propriedades Condicao/Lista Valores SOP
********************************************************************************/
 
/* +++ definicao da biblioteca de funcoes +++ */
{sop\solib001.i}
 
/* +++ definicao de variaveis +++ */
 
PROCEDURE <metodo>:
.
.
.
END PROCEDURE.

Programa Métodos do Programa de Retorno Externo

A validação, verificação de uma condição ou inicialização de um objeto deve ser efetuada por intermédio de métodos do programa.

Prototipação para Lista de Valores e Condição:

PROCEDURE <metodo>:
    DEF OUTPUT PARAM pLogReturn  AS LOGICAL   NO-UNDO.
    DEF OUTPUT PARAM pDesMessage AS CHARACTER NO-UNDO.
  
    /*** lógica especifica ***/
    ...
    ...
    ...
   RETURN.
END PROCEDURE.

Prototipação para Valor Inicial de um objeto:

PROCEDURE <metodo>:
    DEF OUTPUT PARAM pLogReturn  AS LOGICAL   NO-UNDO.
    DEF OUTPUT PARAM pDesMessage AS CHARACTER NO-UNDO.
  
    /*** lógica especifica ***/
    ...
    ...
    ...
   RETURN.
END PROCEDURE.

É de extrema importância que a definição dos parâmetros seja efetuada de acordo com a estrutura acima, inclusive os tipos de dados (logical e character) por extenso. A definição dos parâmetros é reconhecida pelo zoom de lista de valores e condição para validar se o método criado está correto ou não.

Definição dos Parâmetros

PROPRIEDADE	PARÂMETROS	VALOR	Descrição
Condição	pLogReturn	YES	Indica que o botão correspondente deverá ficar desabilitado/escondido.
Condição	pLogReturn	NO	Indica que o botão correspondente deverá permanecer no seu estado atual.
Condição	PDesMessage	-	Não é utilizada.
Lista de Valor	pLogReturn	YES	Indica que a validação do objeto ocorreu com sucesso.
Lista de Valor	pLogReturn	NO	Indica que a validação do objeto não foi bem sucedida. Será apresentada uma mensagem de erro ao usuário.
Lista de Valor	PDesMessage	-	Descrição da mensagem de erro ao usuário, quando pLogReturn = NO.
Valor Inicial	PDesValue	-	Valor para inicialização do objeto (caracter).

Campo

Descrição

Janela Zoom - Opção

A opção ....

Na tabela a seguir estão descritos os elementos desta janela:

Campo	Descrição

PROCEDURE <metodo>:

DEF OUTPUT PARAM pDesValue AS CHARACTER NO-UNDO.

/*** lógica especifica ***/

...

RETURN.

END PROCEDURE.