Histórico da Página
Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | dibo/bodi00895.p |
Considerações Gerais
Objetivo
Esta BO tem como objetivo a manipulação dos dados referentes a tabela reg-msg-loja-erro (Registro da Mensagem da Loja Erro).
Funcionamento
Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.
A execução na forma persistente é realizada através da chamada de um comando RUN conforme exemplo a seguir.
A sintaxe para executar a BO em modo persistente é:
RUN dibo/bodi00895.p PERSISTENT SET h-bodi00895. |
A variável denominada h-bodi00895 irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da BO.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
tt-reg-msg-loja-erro | Entrada/Saída | ||||
Registro da mensagem da loja Erro | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cdn-msg | integer | >>>>>9 | Código da mensagem | Sim |
|
descricao | character | x(60) | Descrição do mensagem | Sim |
|
dsl-help-msg | character | x(2000) | Help da mensagem | Não | |
cdn-seq | integer | >>>>>>>>9 | Sequencia do registro | Sim | |
idi-tipo | integer | >9 | Tipo do Documento | Sim | |
cod-docto | character | x(50) | Número do Documento | Sim | |
cod-estabel | character | x(05) | Código do estabelecimento | Sim | |
cod-dat-hora | character | x(50) | Data e Hora do registro | Sim | |
cod-livre-1 | character | x(100) | Livre 1 | Não | |
cod-livre-2 | character | x(500) | Livre 2 | Não | |
log-livre-1 | logical | Sim/Não | Livre 1 | Não | |
log-livre-2 | logical | Sim/Não | Livre 2 | Não | |
num-livre-1 | integer | >>>>>>>>9 | Livre 1 | Não | |
num-livre-2 | integer | >>>>>>>>9 | Livre 2 | Não | |
val-livre-1 | decimal | ->>>>>>>>>>>9.99999999 | Livre 1 | Não | |
val-livre-2 | decimal | ->>>>>>>>>>>9.99999999 | Livre 2 | Não | |
dat-livre-1 | date | 99/99/9999 | Livre 1 | Não | |
dat-livre-2 | date | 99/99/9999 | Livre 2 | Não |
Método Básico
getCharField | ||
Requisito | Nenhum | |
Sintaxe | RUN getCharField IN handle (INPUT <character>, OUTPUT <character>). | |
Descrição | Retorna valor dos campos do tipo caracter | |
Parâmetros | Descrição | |
pFieldName | Nome do campo caracter que será retornado o valor | |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo caracter que foi solicitado a BO. |
getDateField | ||
Requisito | Nenhum | |
Sintaxe | RUN getDateField IN handle (INPUT <character>, OUTPUT <date>). | |
Descrição | Retorna valor dos campos do tipo data | |
Parâmetros | Descrição | |
pFieldName | Nome do campo data que será retornado o valor | |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo data que foi solicitado a BO. |
getDecField | ||
Requisito | Nenhum | |
Sintaxe | RUN getDecField IN handle (INPUT <character>, OUTPUT <decimal>). | |
Descrição | Retorna valor dos campos do tipo decimal | |
Parâmetros | Descrição | |
pFieldName | Nome do campo decimal que será retornado o valor | |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo decimal que foi solicitado a BO. |
getIntField | ||
Requisito | Nenhum | |
Sintaxe | RUN getIntField IN handle (INPUT <character>, OUTPUT <integer>). | |
Descrição | Retorna valor dos campos do tipo inteiro | |
Parâmetros | Descrição | |
pFieldName | Nome do campo inteiro que será retornado o valor | |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo inteiro que foi solicitado a BO. |
getLogField | ||
Requisito | Nenhum | |
Sintaxe | RUN getLogField IN handle (INPUT <character>, OUTPUT <logical>). | |
Descrição | Retorna valor dos campos do tipo logico | |
Parâmetros | Descrição | |
pFieldName | Nome do campo logico que será retornado o valor | |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo logico que foi solicitado a BO. |
getRawField | ||
Requisito | Nenhum | |
Sintaxe | RUN getRawField IN handle (INPUT <character>, OUTPUT <raw>). | |
Descrição | Retorna valor dos campos do tipo raw | |
Parâmetros | Descrição | |
| pFieldName | Nome do campo raw que será retornado o valor |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo raw que foi solicitado a BO. |
getRecidField | ||
Requisito | Nenhum | |
Sintaxe | RUN getRecidField IN handle (INPUT <character>, OUTPUT <recid>). | |
Descrição | Retorna valor dos campos do tipo recid | |
Parâmetros | Descrição | |
| pFieldName | Nome do campo recid que será retornado o valor |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo recid que foi solicitado a BO. |
getKey | ||
Requisito | Nenhum | |
Sintaxe | RUN getKey IN handle (OUTPUT <character>, OUTPUT <character>, OUTPUT <character>, OUTPUT <integer>). | |
Descrição | Retorna valor do campo do índice rgmsgljr_id2 | |
Parâmetros | Descrição | |
| pcod-estabel | Código do Estabelecimento |
pcod-dat-hora | Data e Hora do registro | |
pcod-docto | Número do documento | |
pcdn-seq | Sequencia do registro | |
Retorno | A BO irá retornar o valor contido no campo código estabelecimento, data e hora do registro, número do documento e sequencia do registro que foi solicitado a BO |
goToKey | ||
Requisito | Nenhum | |
Sintaxe | RUN goToKey IN h-handle (INPUT <character>, INPUT <character>, INPUT <character>, INPUT <integer>). | |
Descrição | Reposiciona registro com base no índice rgmsgljr_id2 | |
Parâmetros | Descrição | |
| pcod-estabel | Código do Estabelecimento |
pcod-dat-hora | Hora e data do registro | |
pcod-docto | Número do documento | |
pcdn-seq | Sequencia do Registro | |
Retorno | A BO irá reposicionar no registro que foi solicitado a BO. |
Métodos de Negócio
OpenQuery / SetConstraint
openQueryMain | ||
Requisito | Nenhum | |
Sintaxe | run openQueryStatic in h-handle (input "Main":U). | |
Descrição | Faz a abertura da tabela principal. | |
Parâmetros | Descrição | |
|
| |
Retorno |
|
validateRecord | ||
Requisito | Nenhum | |
Sintaxe | RUN validateRecord IN h-handle (INPUT <character>). | |
Descrição | Efetua as validações do registro antes de ser gravado na tabela Histórico de Relacionamento do Estabelecimento de Atendimento | |
Parâmetros | Descrição | |
| pType | Parâmetro character para indicar o tipo de gravação do registro (Create, Delete e Update). |
Retorno | “OK” – Registro gravado corretamente “NOK” – Registro inválido, Verificar a lista de erros na temp-table RowErrors |