Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | dibo/bodi181na2.p |
Considerações Gerais
Objetivo
Esta BO tem como objetivo a manipulação dos dados referentes a tabela rota (Arquivo de Rotas de Atendimento do Pedido).
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/bodi181na2.p PERSISTENT SET h-bodi181na2. |
A variável denominada h-handle 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-rota | Entrada/Saída | ||||
Arquivo de Rotas de Atendimento do Pedido | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cod-rota | character | x(12) | Código Rota | Sim |
|
descricao | character | x(40) | Descrição da Rota | Sim |
|
roteiro | character | x(2000) | Especificação do Roteiro | Sim |
|
cod-estabel | character | x(05) | Código do Estabelecimento | Não |
|
check-sum | character | x(20) |
| Não |
|
char-1 | character | x(100) | Código Livre 1 | Não |
|
char-2 | character | x(100) | Código Livre 2 | Não |
|
data-1 | date | 99/99/9999 | Data Livre 1 | Não |
|
data-2 | date | 99/99/9999 | Data Livre 2 | Não |
|
log-1 | logical | Sim/Não | Lógico Livre 1 | Não |
|
log-2 | logical | Sim/Não | Lógico Livre 2 | Não |
|
int-1 | integer | ->>>>>>>>>9 | Número Livre 1 | Não |
|
int-2 | integer | ->>>>>>>>>9 | Número Livre 2 | Não |
|
dec-1 | decimal | ->>>>>>>>>>>9.99999999 | Valor Livre 1 | Não |
|
dec-2 | decimal | ->>>>>>>>>>>9.99999999 | Valor Livre 2 | Não |
|
r-Rowid | Rowid |
|
| 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>). | |
Descrição | Retorna a chave do registro posicionado | |
Parâmetros | Descrição | |
| pcod-rota | Indica o código da rota |
Retorno | A BO irá retornar o valor contido no campo rota que foi solicitado a BO. |
goToKey | ||
Requisito | Nenhum | |
Sintaxe | RUN goToKey IN h-handle (INPUT <character>). | |
Descrição | Reposiciona registro com base na chave informada | |
Parâmetros | Descrição | |
| pcod-rota | Indica o código da rota. |
Retorno | A BO irá reposicionar no registro que foi solicitado a BO. |
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 de campos do portal | |
Parâmetros | Descrição | |
| pType | Indica 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 |
OpenQuery / SetConstraint / LinkTo
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 |
|
openQueryFaixaRota | ||
Requisito | Nenhum | |
Sintaxe | run openQueryStatic in h-handle (input "FaixaRota":U). | |
Descrição | Faz a abertura da tabela respeitando a faixa por código da rota | |
Parâmetros | Descrição | |
|
| |
Retorno |
|
setConstraintFaixaRota | ||
Requisito | Nenhum | |
Sintaxe | run setConstraintFaixaRota in h-handle (input <character>, input <character>). | |
Descrição | Solicita informações para seleção das rotas respeitando a faixa por código da rota | |
Parâmetros | Descrição | |
p-cod-rota-ini | Indica o código da rota inicial | |
| p-cod-rota-fim | Indica o código da rota final |
Retorno |
|