Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
| Nome Físico | dibo/bodi00849.doc |
Considerações Gerais
Objetivo
Esta BO tem como objetivo a manipulação dos dados referentes a tabela relac-estab-atend (Relacionamenteo do Estabelecimento de Atendimento).
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/bodi00849.p PERSISTENT SET h-bodi00849. |
A variável denominada h-bodi00849 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-relac-estab-atend | Entrada/Saída | ||||
Relacionamenteo do Estabelecimento de Atendimento | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
idi-relac-estab-atend | integer | >>>,>>>,>>9 | Id Relacionamentos do Estabelecimento de Atendimento | Sim |
|
cd-emitente | Integer | >>>>>>>>9 | Cliente | Não |
|
nom-micror-dest | character | x(12) | Microrregião Destino | Não |
|
cidade | character | x(25) | Cidade | Não |
|
estado | Character | x(04) | UF | Não |
|
pais | character | x(20) | País | Não |
|
It-codigo | Character | X(16) | Item | Não |
|
fm-codigo | Character | X(08) | Família | Não |
|
fm-cod-com | character | X(08) | Família Comercial | Não |
|
estab-atend | character | x(05) | Estabelecimento Atendimento | Sim |
|
nat-operacao | Character | X(06) | Natureza de Operação | Não |
|
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 <decimal>). | |
Descrição | Retorna valor do campo do índice ordpeso_id2 | |
Parâmetros | Descrição | |
| pcdd-ord-peso | Ordem de Pesagem |
Retorno | A BO irá retornar o valor contido no campo ordem de pesagem que foi solicitado a BO. | |
goToKey | ||
Requisito | Nenhum | |
Sintaxe | RUN goToKey IN h-handle (INPUT <decimal>). | |
Descrição | Reposiciona registro com base no índice ordpeso_id2 | |
Parâmetros | Descrição | |
| pcdd-ord-peso | Ordem de Pesagem |
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 |
| |
openQueryByRange | ||
Requisito | Nenhum | |
Sintaxe | run openQueryStatic in h-handle (input “ByRange”). | |
Descrição | Faz a abertura da tabela principal por faixa. | |
Parâmetros | Descrição | |
|
| |
Retorno |
| |
setConstraintByRange | ||
Requisito | Nenhum | |
Sintaxe | run setConstraintByRange in h-handle (input <integer>, input <integer>, input <character>, input <character>, input <character>, input <character>, input <character>, input <character>, input <character>, input <character>, input <character>, input <character>, input <character>, input <character>, input <character>, input <character>). | |
Descrição | Seta as restrições para abertura da query por Range Informado. | |
Parâmetros | Descrição | |
p-cd-emitente-ini | Cliente | |
| p-cd-emitente-fim | Cliente |
| p-nom-micror-dest-ini | Microrregião |
| p-nom-micror-dest-fim | Microrregião |
| p-cidade-ini | Cidade |
| p-cidade-fim | Cidade |
| p-estado-ini | UF |
| p-estado-fim | UF |
| p-pais-ini | País |
| p-pais-fim | País |
| p-it-codigo-ini | Item |
| p-it-codigo-fim | Item |
| p-fm-codigo-ini | Família |
| p-fm-codigo-fim | Família |
| p-fm-codigo-ini | Família Comercial |
| p-fm-codigo-fim | Família Comercial |
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 Relacionamento do Estabelecimento de Atendimento | |
Parâmetros | Descrição | |
| pType | Parâmetro caracter para indicar o 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 | |
returnKey | ||
Requisito | Nenhum | |
Sintaxe | RUN returnKey IN h-handle (OUTPUT <integer>). | |
Descrição | Retorna a sequência da tabela para criação do registro único | |
Parâmetros | Descrição | |
| p-idi-relac-estab-atend | Parâmetro de retorno da sequência |
Retorno |
| |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas