Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | dibo/bodi702.p |
Objetivo
Esta BO tem como objetivo a manipulação dos dados referentes a tabela mdfe-veic (MDF-e Cadastro de Veículos).
Funcionamento
Na forma padrão, realiza-se a chamada por meio de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.
A execução na forma persistente é realizada por meio da chamada de um comando RUN conforme exemplo a seguir.
A sintaxe para executar a BO em modo persistente é:
RUN dibo/bodi702.p PERSISTENT SET h-handle. |
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-ord-docto-peso | Entrada/Saída | ||||
Documento da ordem de pesagem | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cod-inter-veic | character | x(15) | Codigo Interno Veiculo | Sim | |
cdn-tip-veic | integer | 99 | Tipo Veículo | Não | |
cod-capac-kg | character | x(8) | Capacidade KG | Não | |
cod-capac-m3 | character | x(8) | Capacidade M3 | Não | |
cod-livre-1 | character | x(500) | Livre 1 | Não | |
cod-livre-2 | character | x(500) | Livre 2 | Não | |
cod-livre-3 | character | x(500) | Livre 3 | Não | |
cod-livre-4 | character | x(500) | Livre 4 | Não | |
cod-livre-5 | character | x(500) | Livre 5 | Não | |
cod-placa | character | x(30) | Placa | Não | |
cod-rntrc | character | x(20) | RNTRC | Não | |
cod-tara-kg | character | x(8) | Tara KG | Não | |
dat-livre-1 | date | 99/99/9999 | Livre 1 | Não | |
dat-livre-2 | date | 99/99/9999 | Livre 2 | Não | |
dat-livre-3 | date | 99/99/9999 | Livre 3 | Não | |
dat-livre-4 | date | 99/99/9999 | Livre 4 | Não | |
dat-livre-5 | date | 99/99/9999 | Livre 5 | Não | |
log-livre-1 | logical | Sim/Não | Livre 1 | Não | |
log-livre-2 | logical | Sim/Não | Livre 2 | Não | |
log-livre-3 | logical | Sim/Não | Livre 3 | Não | |
log-livre-4 | logical | Sim/Não | Livre 4 | Não | |
log-livre-5 | logical | Sim/Não | Livre 5 | Não | |
num-livre-1 | integer | ->>>>>>>>9 | Livre 1 | Não | |
num-livre-2 | integer | ->>>>>>>>9 | Livre 2 | Não | |
num-livre-3 | integer | ->>>>>>>>9 | Livre 3 | Não | |
num-livre-4 | integer | ->>>>>>>>9 | Livre 4 | Não | |
num-livre-5 | integer | ->>>>>>>>9 | Livre 5 | Não | |
qtd-capac-vol | decimal | >>>,>>>,>>9.9999 | Capacidade Volumétrica | Não | |
val-livre-1 | decimal | ->>>>>>>>>>>9.9999 | Livre 1 | Não | |
val-livre-2 | decimal | ->>>>>>>>>>>9.9999 | Livre 2 | Não | |
val-livre-3 | decimal | ->>>>>>>>>>>9.99999999 | Livre 3 | Não | |
val-livre-4 | decimal | ->>>>>>>>>>>9.99999999 | Livre 4 | Não | |
val-livre-5 | decimal | ->>>>>>>>>>>9.99999999 | Livre 5 | Não |
Métodos Básicos
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. |
getTableMdfeVeic | ||
Requisito | Nenhum | |
Sintaxe | RUN getTableMdfeVeic IN handle (INPUT <character>, OUTPUT <table>). | |
Descrição | Retorna uma temp-table com os dados solicitados de acordo com o Código Interno do Veículo. | |
Parâmetros | Descrição | |
| p-cod-inter-veic | Código Interno Veículo |
| Rowobject-aux | Tabela temporária contendo os dados da faixa solicitada. |
Retorno | A BO irá retornar a tabela contendo os dados que foram solicitados a BO. |
getTableMdfeVeicByPlaca | ||
Requisito | Nenhum | |
Sintaxe | RUN getTableMdfeVeicByPlaca IN handle (OUTPUT <table>). | |
Descrição | Retorna uma temp-table com os dados de uma faixa de placas. Para utilizar esta procedure é necessário executar a procedure setConstraintPlaca antes. | |
Parâmetros | Descrição | |
| Rowobject-aux | Tabela temporária contendo os dados da faixa solicitada. |
Retorno | A BO irá retornar a tabela contendo os dados que foram solicitados a BO. |
getKey | ||
Requisito | Nenhum | |
Sintaxe | RUN getKey IN handle (OUTPUT <character>). | |
Descrição | Retorna valor do campo do índice mdfeveic-id | |
Parâmetros | Descrição | |
| pcod-inter-veic | Codigo Interno Veiculo |
Retorno | A BO irá retornar o valor contido no campo código interno veículo que foi solicitado a BO. |
goToKey | ||
Requisito | Nenhum | |
Sintaxe | RUN goToKey IN h-handle (INPUT <character>). | |
Descrição | Reposiciona registro com base no índice mdfeveic-id | |
Parâmetros | Descrição | |
| pcod-inter-veic | Codigo Interno Veiculo |
Retorno | A BO irá reposicionar no registro que foi solicitado a BO. |
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 |
openQueryCodigo | ||
Requisito | Nenhum | |
Sintaxe | run openQueryStatic in h-handle (input “Codigo”). | |
Descrição | Faz a abertura da tabela principal pelo código interno do veículo. | |
Parâmetros | Descrição | |
| ||
Retorno |
openQueryPlaca | ||
Requisito | Nenhum | |
Sintaxe | run openQueryStatic in h-handle (input “Placa”). | |
Descrição | Faz a abertura da tabela principal pela placa e pelo código interno do veículo. | |
Parâmetros | Descrição | |
| ||
Retorno |
openQueryrntrc | ||
Requisito | Nenhum | |
Sintaxe | run openQueryStatic in h-handle (input “rntrc”). | |
Descrição | Faz a abertura da tabela principal pela placa e pelo RNTRC e pelo código interno do veículo. | |
Parâmetros | Descrição | |
| ||
Retorno |
setConstraintCodigo | ||
Requisito | Nenhum | |
Sintaxe | run setConstraintCodigo in h-handle (input <character>, input <character>). | |
Descrição | Seta as restrições para abertura da query pelo código interno do veículo. | |
Parâmetros | Descrição | |
p-cod-inter-veic-ini | Codigo Interno Veiculo inicial | |
| p-cod-inter-veic-fim | Codigo Interno Veiculo final |
Retorno |
setConstraintPlaca | ||
Requisito | Nenhum | |
Sintaxe | run setConstraintPlaca in h-handle (input <character>, input <character>). | |
Descrição | Seta as restrições para abertura da query pela placa do veículo. | |
Parâmetros | Descrição | |
p-cod-placa-ini | Placa inicial | |
| p-cod-placa-fim | Placa final |
Retorno |
setConstraintRNTRC | ||
Requisito | Nenhum | |
Sintaxe | run setConstraintRNTRC in h-handle (input <character>, input <character>). | |
Descrição | Seta as restrições para abertura da query pelo RNTRC. | |
Parâmetros | Descrição | |
p-cod-rntrc-ini | RNTRC inicial | |
| p-cod-rntrc-fim | RNTRC final |
Retorno |