Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | inbo/boin311.p |
RecordSet
tt-pl-it-prod
tt-pl-it-prod | ||||
Atributo | Tipo | Formato | Descrição | Obr. |
cd-plano | inte | >>9 | Plano | Sim |
It-codigo | char | x(16) | Item | Sim |
Ano | inte | 9999 | Ano | Sim |
Periodo | inte | >>9 | Período | Sim |
Quantidade | deci-2 | >>>>,>>9.99 | Qtde | Sim |
Dt-termino | date | 99/99/9999 | Data Término | Sim |
Qt-confirm | deci-2 | >>>>,>>9.99 | Qtde Conf | Sim |
Nome-abrev | char | x(12) | Nome Abreviado | Sim |
Nr-pedcli | char | x(12) | Pedido Cliente | Sim |
Cod-gr-cli | inte | >9 | Grupo Cliente | Sim |
Cod-refer | char | x(8) | Referência | Sim |
Origem | char | x(01) | Origem | Sim |
Nr-sequencia | inte | >>,>>9 | Sequencia | Sim |
Nr-estrut | inte | >>>>>>9 | Estrutura |
|
Nr-entrega | inte | >>>>9 | Entrega |
|
Char-1 | char | x(100) | ? |
|
Char-2 | char | x(100) | ? |
|
Dec-1 | deci-2 | ->>>>>>>>>>>9.9 | ? |
|
Dec-2 | deci-2 | ->>>>>>>>>>>9.9 | ? |
|
Int-1 | inte | ->>>>>>>>>9 | ? |
|
Int-2 | inte | ->>>>>>>>>9 | ? |
|
Log-1 | logi | Sim/Não | ? |
|
Log-2 | logi | Sim/Não | ? |
|
Data-1 | date | 99/99/9999 | ? |
|
Data-2 | date | 99/99/9999 | ? |
|
Check-sum | char | x(20) | Check-sum |
|
Métodos Básicos
Métodos básicos de acesso ao banco de dados.
Método:
goToKey
Descrição:
Reposiciona registro com base no índice CODIGO
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pcd-plano | int |
| X |
|
| Plano |
pit-codigo | char |
| X |
|
| Item |
pcod-refer | char |
| X |
|
| Referência |
pano | int |
| X |
|
| Ano |
pperiodo | int |
| X |
|
| Período |
pnome-abrev | char |
| X |
|
| Nome Abreviado |
pnr-pedcli | char |
| X |
|
| Pedido Cliente |
pnr-sequencia | int |
| X |
|
| Sequência |
pcod-gr-cli | int |
| X |
|
| Grupo Cliente |
Método:
getKey
Descrição:
Retorna valores dos campos do índice CODIGO
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pcd-plano | int |
|
| X |
| Plano |
pit-codigo | char |
|
| X |
| Item |
pcod-refer | char |
|
| X |
| Referência |
pano | int |
|
| X |
| Ano |
pperiodo | int |
|
| X |
| Período |
pnome-abrev | char |
|
| X |
| Nome Abreviado |
pnr-pedcli | char |
|
| X |
| Pedido Cliente |
pnr-sequencia | int |
|
| X |
| Sequência |
pcod-gr-cli | int |
|
| X |
| Grupo Cliente |
Método:
goToKeyCdPlano
Descrição:
Posiciona o registro utilizando somente o Plano, o Ano e o Período
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pcd-plano | int |
| X |
|
| Plano |
pano | int |
| X |
|
| Ano |
pperiodo | int |
| X |
|
| Período |
Método:
goToKeyItem
Descrição:
Posiciona o registro no primeiro que encontrar com o item informado
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pit-codigo | char |
| X |
|
| Item |
goToKeyRowid
Descrição:
Posiciona o registro com base no rowid.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
prowid | rowid |
| X |
|
| Rowid do registro desejado |
Método:
validateRecord
Descrição:
Valida temptable RowObject
Requisitos:
Nenhum
Parâmetros:
Recebe o tipo de validação (Create, Delete, Update)
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pType | char |
| X |
|
| Recebe o tipo de validação |
Método:
getCharField
Descrição:
Retorna o valor de um campo character.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pFieldName | char |
| X |
|
| Nome Campo |
pFieldValue | char |
|
| X |
| Valor Campo |
Método:
getDecField
Descrição:
Retorna o valor de um campo decimal.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pFieldName | char |
| X |
|
| Nome Campo |
pFieldValue | decimal |
|
| X |
| Valor Campo |
Método:
getIntField
Descrição:
Retorna o valor de um campo inteiro.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição | |
pFieldName | char |
| X |
|
| Nome Campo | |
pFieldValue | integer |
|
| X |
| Valor Campo |
Método:
getDateField
Descrição:
Retorna o valor de um campo date.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição | |
pFieldName | char |
| X |
|
| Nome Campo | |
pFieldValue | date |
|
| X |
| Valor Campo |
Método:
getLogField
Descrição:
Retorna o valor de um campo logical.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição | |
pFieldName | char |
| X |
|
| Nome Campo | |
pFieldValue | logical |
|
| X |
| Valor Campo |
Método:
getRawField
Descrição:
Retorna valor de campos do tipo raw.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição | |
pFieldName | char |
| X |
|
| Nome Campo | |
pFieldValue | raw |
|
| X |
| Valor Campo |
Método:
getRecidField
Descrição:
Retorna valor de campos do tipo recid.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição | |
pFieldName | char |
| X |
|
| Nome Campo | |
pFieldValue | recid |
|
| X |
| Valor Campo |
Queries e Constraints
Definição das Queries (acesso ao banco de dados) e Contraints (regras de leitura) utilizadas para buscar grupos de registros da base de dados.
Método:
OpenQueryStatic ("Main")
Descrição:
Busca conjunto de registros da tabela pl-it-prod.
Método:
OpenQueryStatic ("Plano")
Descrição:
Busca conjunto de registros da tabela pl-it-prod conforme o código do plano.
Constraints Associados:
Executar o método setConstraintPlano.
Método:
OpenQueryStatic ("Filtro")
Descrição:
Busca conjunto de registros da tabela pl-it-prod contendo o código do plano, uma faixa do ano e do período. Ordena por item, referência, ano e período.
Método:
SetConstraintPlano
Descrição: Seta as variáveis de controle para queries contendo o código do plano.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pcd-plano | inte |
| X |
|
| Código Plano |
Método:
SetConstraintPlanoPeriodo
Descrição:
Seta as variáveis de controle para queries contendo o nr do plano, periodo inicial e final.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pcd-plano | inte |
| X |
|
| Nr Plano |
pi-per-ini | char |
| X |
|
| Período Inicial |
pi-per-fim | char |
| X |
|
| Período Final |
Métodos Negócio
Métodos adicionais de atualização e acesso a base de dados .
Método:
atualizarRegistro
Descrição:
Atualizar os Itens do Plano - programa pl0301.
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
table for tt2-pl-it-prod |
|
|
|
| X | Temp Table para pl-it-prod |
Método:
atualizarTransferencia
Descrição:
Procedure utilizada pelo programa pl0301 para fazer transferência de quantidades de itens entre um período e outro.
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
table for tt-before |
|
|
|
| X | Temp Table antes da transferência |
r-before | rowid |
| X |
|
| Rowid registro anterior que foi alterado |
p-cd-plano | int |
| X |
|
| Código Plano |
p-estabel | char |
| X |
|
| Estabelecimento (Release 203) |
p-ano | int |
| X |
|
| Ano |
p-periodo | int |
| X |
|
| Período |
p-nome-abrev | char |
| X |
|
| Nome Cliente |
p-nr-pedcli | char |
| X |
|
| Nr Pedido |
p-sequencia | int |
| X |
|
| Sequência |
p-cod-gr-cli | int |
| X |
|
| Grupo de Cliente |
p-dt-trans | date |
| X |
|
| Data Término |
p-quant-dest | dec |
| X |
|
| Qtde Destino |
Método:
eliminarTransferencia
Descrição:
Utilizado pelo programa pl0301 para eliminar o registro de Itens do Plano caso na transferência tenha sido transferida toda a quantidade do registro e o mesmo ter ficado com quantidade zero.
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
table for tt-before |
|
| X |
|
| Temp Table do registro transferido |
r-before | rowid |
| X |
|
| Rowid do registro |
Método:
gerarBrowsePeriodo
Descrição:
Gera a temp-table para o programa pl0301cc.w - Opção Modifica do pl0301c.w.
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
p-rowid | rowid |
| X |
|
| Rowid do registro atual |
c-refer | char |
| X |
|
| Referência |
table for tt2-pl-it-prod |
|
|
|
| X | Temp Table para o browser |
Método:
PosicionarPlItProd
Descrição:
Utilizada pelo pl0301c.w, no botão Posicionar, para posicionar o registro na viewer.
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pi-plano | inte |
| X |
|
| Código Plano |
pit-codigo | char |
| X |
|
| Código Item |
pi-ano-ini | inte |
| X |
|
| Ano Inicial |
pi-ano-fim | inte |
| X |
|
| Ano Final |
pi-per-ini | inte |
| X |
|
| Período Inicial |
pi-per-fim | inte |
| X |
|
| Período Final |
r-rowid | rowid |
|
| X |
| Rowid do registro |
Método:
GerarPlanilha
Descrição:
Gera temp-table tt-planilha e tt-coluna para o pl0301f.w.
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
i-cd-tipo | inte |
| X |
|
| Código Plano |
i-ano-i | inte |
| X |
|
| Ano Inicial |
i-ano-f | inte |
| X |
|
| Ano Final |
i-periodo-i | inte |
| X |
|
| Período Inicial |
i-periodo-f | inte |
| X |
|
| Período Final |
c-it-codigo-i | char |
| X |
|
| Código Item Inicial |
c-it-codigo-f | char |
| X |
|
| Código Item Final |
c-fm-codigo-i | char |
| X |
|
| Família Inicial |
c-fm-codigo-f | char |
| X |
|
| Família Final |
i-ge-codigo-i | inte |
| X |
|
| Grupo Estoque Inicial |
i-ge-codigo-f | inte |
| X |
|
| Grupo Estoque Final |
c-cd-planej-i | char |
| X |
|
| Planejador Inicial |
c-cd-planej-f | char |
| X |
|
| Planejador final |
table for tt-planilha |
|
|
|
| X |
|
table for tt-coluna |
|
|
|
| X |
|
Método:
findParamGlobal
Descrição:
Procura os Parâmetros Globais e Retorna o Módulo.
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-modulo | char |
| X |
|
| Recebe módulo solicitado |
l-implant | logi |
|
| X |
| Retorna valor se o módulo está implantado ou não |
Método:
assignQuantItem
Descrição:
Atualiza a quantidade do item do plano.
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
p-quant | deci |
| X |
|
| Quantidade Nova |
Método:
createItemPlano
Descrição:
Cria um novo registro de item do plano.
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
table for tt-planilha |
|
| X |
|
| tt-planilha |
p-cd-plano |
|
| X |
|
| Código Plano |
p-ano |
|
| X |
|
| Ano |
p-periodo |
|
| X |
|
| Período |
p-termino |
|
| X |
|
| Data Término |
p-quant |
|
| X |
|
| Quantidade |
p-rowid |
|
|
| X |
| Rowid do novo registro |
Método:
deleteRowidItemPlano
Descrição:
Elimina o item do plano em função do rowid informado.
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
p-rowid | rowid |
| X |
|
| Rowid Item |
Método:
gerarColuna
Descrição:
Gerar a temp-table tt-coluna que será utilizada no pl0301f.w
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
i-cd-tipo |
|
| X |
|
| Tipo Periodo |
i-ano-i |
|
| X |
|
| Ano Inicial |
i-ano-f |
|
| X |
|
| Ano Final |
i-periodo-i |
|
| X |
|
| Período Inicial |
i-periodo-f |
|
| X |
|
| Período Final |
i-flag |
|
| X |
|
| Flag |
i-nr-periodo |
|
|
| X |
| Período |
table for tt-coluna |
|
|
| X |
| tt-coluna |
table for tt-valores |
|
|
| X |
| tt-valores |
Método:
GerarItensPlano
Descrição:
Gera a temp-table RowObject para o programa pl0301c.w
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
table for RowObject |
|
|
| X |
| Temp-table RowObject |
Método:
getRowidItem
Descrição:
Retorna o rowid do registro onde a query está posicionada.
Requisitos:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
prowid | rowid |
|
| X |
| Rowid do registro |