Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | dibo/bodi167na.p |
Considerações Gerais
Objetivo
Esta BO tem como objetivo a manipulação dos dados referentes a tabela prog-ent (Programação de entrega do item).
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/bodi167na.p PERSISTENT SET h-bodi167na. |
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-prog-ent | Entrada/Saída | ||||
Programação de Entrega do Item | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cd-freq | integer | >>9 | Código da frequência de fornecimento do item | Sim | |
cd-origem | integer | 99 | Indica de qual forma foram obtidas as informações | Sim | |
cd-situacao | integer | 99 | Situação da entrega no item do programa | Sim | |
char-1 | character | x(100) | Código Livre 1 | Não | |
char-2 | character | x(100) | Código Livre 2 | Não | |
check-sum | character | x(20) | Não | ||
cod-entrega | character | x(12) | Código do endereço de entrega | Sim | |
cod-refer | character | x(8) | Código de referência do item | Sim | |
data-1 | date | 99/99/9999 | Data Livre 1 | Não | |
data-2 | date | 99/99/9999 | Data Livre 2 | Não | |
dec-1 | decimal | ->>>>>>>>>>>9.99999999 | Valor Livre 1 | Não | |
dec-2 | decimal | ->>>>>>>>>>>9.99999999 | Valor Livre 2 | Não | |
dt-alter | date | 99/99/9999 | Data da última alteração da entrega | Não | |
dt-cancel | date | 99/99/9999 | Data do cancelamento da entrega | Não | |
dt-entrega | date | 99/99/9999 | Data de entrega do item solicitada no programa | Sim | |
dt-implant | date | 99/99/9999 | Data da implantação da entrega no item do programa | Sim | |
hr-entrega | character | 99:99:99 | Hora de entrega do item solicitada no programa | Sim | |
int-1 | integer | ->>>>>>>>>9 | Número Livre 1 | Não | |
int-2 | integer | ->>>>>>>>>9 | Número Livre 2 | Não | |
it-codigo | character | x(16) | Código do item | Sim | |
log-1 | logical | Sim/Não | Lógico Livre 1 | Não | |
log-2 | logical | Sim/Não | Lógico Livre 2 | Não | |
log-control-cham | logical | Sim/Não | Controla chamado | Sim | |
motivo-can | character | x(2000) | Motivo do cancelamento da entrega | Sim | |
motivo-imp | character | x(2000) | Motivo na implantação da entrega no item do programa | Sim | |
nr-entrega | integer | >>>>9 | Número de sequência da entrega do item do pedido | Sim | |
nr-pedcli | character | x(12) | Número do pedido do cliente | Sim | |
nr-pedido | integer | >>>,>>>,>>9 | Número do pedido | Sim | |
nr-programa | integer | >>>,>>>,>>9 | Número do programa | Sim | |
qt-pedida | decimal | >>>,>>>,>>9.9999 | Quantidade do item solicitada no programa | Sim | |
qt-un-fat | decimal | >>>>,>>9.9999 | Quantidade na UM utilizada para faturamento do item | Não | |
tp-entrega | integer | 99 | Tipo de entrega | Sim | |
user-alter | character | x(12) | Usuário responsável pela última alteração da entrega | Não | |
user-cancel | character | x(12) | Usuário responsável pelo cancelamento da entrega | Não | |
user-implant | character | x(12) | Usuário responsável pela implantação da entrega no item do programa | Sim | |
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. |
getKey | ||
Requisito | Nenhum | |
Sintaxe | RUN getKey IN handle (OUTPUT <integer>, OUTPUT <character>, OUTPUT <character>, OUTPUT <character>, OUTPUT <character>, OUTPUT <integer>,). | |
Descrição | Retorna a chave do registro posicionado | |
Parâmetros | Descrição | |
| pnr-programa | Indica o número de sequência da entrega do item do pedido |
pit-codigo | Indica o código do item | |
pcod-refer | Indica o código da referência do item | |
pcod-entrega | Indica o código de entrega do item | |
pnr-pedcli | Indica o número do pedido cliente | |
pnr-entrega | Indica o número de sequência da entrega do item do pedido | |
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 <integer>, INPUT <character>, INPUT <character>, INPUT <character>, INPUT <character>, INPUT <integer>,). ). | |
Descrição | Reposiciona registro com base na chave informada | |
Parâmetros | Descrição | |
| pnr-programa | Indica o número de sequência da entrega do item do pedido |
pit-codigo | Indica o código do item | |
pcod-refer | Indica o código da referência do item | |
pcod-entrega | Indica o código de entrega do item | |
pnr-pedcli | Indica o número do pedido cliente | |
pnr-entrega | Indica o número de sequência da entrega do item do pedido | |
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 |
openQueryChamado | ||
Requisito | Nenhum | |
Sintaxe | run openQueryStatic in h-handle (input "Chamado":U). | |
Descrição | Faz a abertura da tabela respeitando o rowid da tabela prog-ent (Programação de entrega do item) | |
Parâmetros | Descrição | |
| ||
Retorno |
openQueryEntradaChamado | ||
Requisito | Nenhum | |
Sintaxe | run openQueryStatic in h-handle (input "EntradaChamado":U). | |
Descrição | Faz a abertura da tabela respeitando a faixa pelo número de sequência da entrega do item, código do item, código da referência do item e número número de sequência da entrega do item | |
Parâmetros | Descrição | |
| ||
Retorno |
setConstraintChamado | ||
Requisito | Nenhum | |
Sintaxe | run setConstraintChamado in h-handle (input <rowid>). | |
Descrição | Solicita informações para seleção da programação de entrega do item respeitando a faixa por número de sequência da entrega do item, código do item, código da referência do item e número de sequência da entrega do item | |
Parâmetros | Descrição | |
p-rowid | Indica o rowid | |
Retorno |
setConstraintEntradaChamado | ||
Requisito | Nenhum | |
Sintaxe | run setConstraintEntradaChamado in h-handle (input <integer>, input <integer>, input <character>, input <character>, input <character>, input <character>, input <integer>, input <integer>). | |
Descrição | Solicita informações para seleção das rotas respeitando a faixa por código da rota | |
Parâmetros | Descrição | |
p-nr-prog-ini | Indica número de sequência da entrega do item inicial | |
| p-nr-prog-fim | Indica número de sequência da entrega do item final |
p-it-codigo-ini | Indica o código do item inicial | |
p-it-codigo-fim | Indica o código do item final | |
p-cod-refer-ini | Indica o código de referência item inicial | |
p-cod-refer-fim | Indica o código do referência final | |
p-nr-entrega-ini | Indica número de sequência da entrega do item inicial | |
p-nr-entrega-fim | Indica número de sequência da entrega do item final | |
Retorno |