BO da tabela antecip-import
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | cxbo/bocx00451.p |
Include com Parâmetros: | cxbo/bocx00451.i |
Banco: | mgcex |
Tabela: | antecip-import |
Objetivo
Esta BO tem como objetivo a manipulação dos dados referentes a tabela antecip-import (Antecipações de Importação vinculadas ao Embarque).
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 cxbo/bocx00451.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
Temp-Tables principais utilizadas para comunicação dos métodos da BO com o mundo externo e suas respectivas definições.
Nos atributos das tabelas temporárias de entrada e saída:
RowObject, RowObjectAux | ||||
Atributos | Tipo | Formato | Descrição | Obr. |
cdd-id-antecip | DECIMAL | >>>,>>>,>>9 | Id antecipação | Sim |
cod-estabel | CHARACTER | x(5) | Estabelecimento do embarque de importação | Sim |
cod-embarq | CHARACTER | x(16) | Embarque de importação | Sim |
num-pedido | INTEGER | >>>>>,>>9 | Número do pedido de compras | Sim |
serie-docto | CHARACTER | x(5) | Série do documento | Sim |
nro-docto | CHARACTER | x(16) | Número do documento | Sim |
cdn-emitente | INTEGER | >>>>>>>>9 | Código do emitente do documento | Sim |
nat-operacao | CHARACTER | x(6) | Natureza de operação do documento | Sim |
cod-estab-ap | CHARACTER | x(5) | Estabelecimento do titulo do contas a pagar | Sim |
cod-espec-docto-ap | CHARACTER | x(3) | Espécie do título do contas a pagar | Sim |
cod-ser-docto-ap | CHARACTER | x(5) | Série do título do contas a pagar | Sim |
cod-tit-ap | CHARACTER | x(10) | Título do contas a pagar | Sim |
cod-parc-ap | CHARACTER | x(2) | Parcela do título do contas a pagar | Sim |
cod-refer-antecip-ap | CHARACTER | x(10) | Referência da antecipação do contas a pagar | Sim |
cdn-emitente-ap | INTEGER | >>>>>>>>9 | Emitente do título do contas a pagar | Sim |
nom-abrev-ap | CHARACTER | x(15) | Nome abreviado emitente contas a pagar | Não |
cod-moed-ap | CHARACTER | x(8) | Moeda do titulo do contas a pagar | Não |
cod-empres-ap | CHARACTER | x(3) | Empresa do título do contas a pagar | Não |
cod-usuar-criac | CHARACTER | x(12) | Usuário da criação do registro | Não |
dtm-criac | DATETIME | 99/99/9999 hh:mm:ss.sss | Data de criação do registro | Não |
dat-cotac-nacionaliz | DATE | 99/99/9999 | Data da cotação da moeda na nacionalização | Não |
dat-transacao | DATE | 99/99/9999 | Data da transação do título no contas a pagar | Não |
dat-emis | DATE | 99/99/9999 | Data de emissão do título no contas a pagar | Não |
dat-vencto-tit | DATE | 99/99/9999 | Data de vencimento do título do contas a pagar | Não |
dat-prev-pagto | DATE | 99/99/9999 | Data prevista para o pagamento do titulo no contas a pagar | Não |
dat-ult-pagto | DATE | 99/99/9999 | Data último pagamento efetuado do titulo no contas a pagar | Não |
dat-ult-apurac-variac-val | DATE | 99/99/9999 | Última apuração variação valor do título | Não |
dat-liquidac-tit-ap | DATE | 99/99/9999 | Data de liquidação do titulo contas a pagar | Não |
val-sdo-tit-ap | DECIMAL | ->>>,>>>,>>9.99 | Saldo do título no contas a pagar | Não |
val-origin-tit-ap | DECIMAL | ->>>,>>>,>>9.99 | Valor original do título no contas a pagar | Não |
val-entr-transf-estab | DECIMAL | ->>>,>>>,>>9.99 | Entrada transferência estabelecimento | Não |
val-liber-pagto-orig-tot | DECIMAL | ->>>,>>>,>>9.99 | Valor total liberado para pagamento do título | Não |
val-tot-pagto-tit-ap | DECIMAL | ->>>,>>>,>>9.99 | Valor total do pagamento do título | Não |
val-vinc-embarq | DECIMAL | ->>>,>>>,>>9.99 | Valor vinculado ao embarque | Não |
val-cotac-nacionaliz | DECIMAL | >>>>,>>9.9999999999 | Valor da cotação na nacionalização | Não |
val-cotac-tit | DECIMAL | >>>>,>>9.9999999999 | Cotação do título | Não |
val-cotac-tit-inver | DECIMAL | ->>,>>>,>>>,>>9.999999999 | Cotação inversa do título | Não |
val-origin-tit-ap-aux | DECIMAL | ->>>,>>>,>>9.99 | Valor original título contas a pagar auxiliar | Não |
val-sdo-tit-ap-aux | DECIMAL | ->>,>>>,>>>,>>9.99 | Valor saldo título contas a pagar auxiliar | Não |
cod-livre-1 | CHARACTER | x(500) | Código livre 1 | Não |
cod-livre-2 | CHARACTER | x(500) | Código livre 2 | Não |
dat-livre-1 | DATE | 99/99/9999 | Data livre 1 | Não |
dat-livre-2 | DATE | 99/99/9999 | Data livre 2 | Não |
log-livre-1 | LOGICAL | sim/não | Lógico livre 1 | Não |
log-livre-2 | LOGICAL | sim/não | Lógico livre 2 | Não |
num-livre-1 | INTEGER | >>>>>>>>9 | Número livre 1 | Não |
num-livre-2 | INTEGER | >>>>>>>>9 | Número livre 2 | Não |
val-livre-1 | DECIMAL | ->>>>>>>>>>>9.99999999 | Valor livre 1 | Não |
val-livre-2 | DECIMAL | ->>>>>>>>>>>9.99999999 | Valor livre 2 | Não |
r-Rowid | ROWID | x(8) | R-rowid | Não |
tt-param-antecip | ||||
Atributos | Tipo | Formato | Descrição | Obr. |
cod-estab-ini | CHARACTER | x(5) | Estabelecimento do titulo do contas a pagar | Sim |
cod-estab-fim | CHARACTER | x(5) | Estabelecimento do titulo do contas a pagar | Sim |
cdn-emitente-ini | INTEGER | >>>>>>>>9 | Emitente do título do contas a pagar | Sim |
cdn-emitente-fim | INTEGER | >>>>>>>>9 | Emitente do título do contas a pagar | Sim |
dat-transacao-ini | DATE | 99/99/9999 | Data da transação do titulo no contas a pagar | Não |
dat-transacao-fim | DATE | 99/99/9999 | Data da transação do titulo no contas a pagar | Não |
cod-espec-docto-ini | CHARACTER | x(3) | Espécie do título do contas a pagar | Sim |
cod-espec-docto-fim | CHARACTER | x(3) | Espécie do título do contas a pagar | Sim |
cod-ser-docto-ini | CHARACTER | x(5) | Série do título do contas a pagar | Sim |
cod-ser-docto-fim | CHARACTER | x(5) | Série do título do contas a pagar | Sim |
cod-tit-ap-ini | CHARACTER | x(10) | Título do contas a pagar | Sim |
cod-tit-ap-fim | CHARACTER | x(10) | Título do contas a pagar | Sim |
tt_tit_ap_antecip_sdo | ||||
Atributos | Tipo | Formato | Descrição | Obr. |
tta_cod_estab | CHARACTER | x(5) | Estabelecimento | Não |
tta_cod_espec_docto | CHARACTER | x(3) | Espécie documento | Não |
tta_cod_ser_docto | CHARACTER | x(5) | Série documento | Não |
tta_cod_tit_ap | CHARACTER | x(10) | Título | Não |
tta_cod_parcela | CHARACTER | x(02) | Parcela | Não |
tta_cod_refer | CHARACTER | x(10) | Referência | Não |
tta_cdn_fornecedor | INTEGER | >>>,>>>,>>9 | Fornecedor | Não |
tta_nom_abrev_fornec | CHARACTER | x(15) | Nome abreviado | Não |
tta_cod_indic_econ | CHARACTER | x(8) | Moeda | Não |
tta_val_sdo_tit_ap | DECIMAL | ->>>,>>>,>>9.99 | Valor saldo | Não |
tta_dat_transacao | DATE | 99/99/9999 | Data transação | Não |
ttv_rec_tit_ap | RECID | >>>>>>9 | RECID do registro | Não |
tta_cod_empresa | CHARACTER | x(3) | Empresa | Não |
tta_val_origin_tit_ap | DECIMAL | ->>>,>>>,>>9.99 | Valor original | Não |
tta_val_entr_transf_estab | DECIMAL | ->>>,>>>,>>9.99 | Entr transf estab | Não |
ttv_val_liber_pagto_orig_tot | DECIMAL | ->>>,>>>,>>9.99 | Total liberado | Não |
ttv_val_tot_pagto_tit_ap | DECIMAL | ->>>,>>>,>>9.99 | Total pagamentos | Não |
tta_dat_emis_docto | DATE | 99/99/9999 | Data emissão | Não |
tta_dat_vencto_tit_ap | DATE | 99/99/9999 | Data vencimento | Não |
tta_dat_prev_pagto | DATE | 99/99/9999 | Data prevista pgto | Não |
tta_dat_ult_pagto | DATE | 99/99/9999 | Data último pagto | Não |
tta_dat_ult_apurac_variac_val | DATE | 99/99/9999 | Ult apur variac val | Não |
tta_dat_liquidac_tit_ap | DATE | 99/99/9999 | Data liquidação | Não |
ttv_val_origin_tit_ap_aux | DECIMAL | ->>>,>>>,>>9.99 | Valor original | Não |
ttv_val_sdo_tit_ap_aux | DECIMAL | ->>,>>>,>>>,>>9.99 | Valor saldo | Não |
ttv_val_cotac_indic_econ_aux | DECIMAL | >>>>,>>9.9999999999 | Cotação | Não |
ttv_val_cotac_indic_econ_inver | DECIMAL | ->>,>>>,>>>,>>9.999999999 | Cotação inversa | Não |
tt_tit_ap_antecip_sdo_a_vincular Obs.: Definição like à temp-table tt_tit_ap_antecip_sdo mais os campos definidos abaixo. | ||||
Atributos | Tipo | Formato | Descrição | Obr. |
tta_val_sdo_vincular | DECIMAL | ->>>,>>>,>>9.99 | Valor a vincular | Não |
Métodos Negócio
Métodos de acesso e leitura a base de dados.
Método: getCharfield
Descrição: Retorna o campo solicitado do registro que estiver posicionado. Só para campos caracteres.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-nome-campo | Char | X |
|
| Nome do campo. | |
c-retorno | Char |
| X |
| Campo solicitado |
Método: getIntfield
Descrição: Retorna o campo solicitado do registro que estiver posicionado. Só para campos inteiros.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-nome-campo | Char | X |
|
| Nome do campo. | |
i-retorno | Inte |
| X |
| Campo solicitado |
Método: getDecfield
Descrição: Retorna o campo solicitado do registro que estiver posicionado. Só para campos decimais.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-nome-campo | Char | X |
|
| Nome do campo. | |
De-retorno | Dec |
| X |
| Campo solicitado |
Método: getLogfield
Descrição: Retorna o campo solicitado do registro que estiver posicionado. Só para campos lógicos.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-nome-campo | Char | X |
|
| Nome do campo. | |
l-retorno | Log |
| X |
| Campo solicitado |
Método: getDatefield
Descrição: Retorna o campo solicitado do registro que estiver posicionado. Só para campos do tipo data.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-nome-campo | Char | X |
|
| Nome do campo. | |
da-retorno | Date |
| X |
| Campo solicitado |
Método: getRawField
Descrição: Retorna o campo solicitado do registro que estiver posicionado. Só para campos do tipo Raw.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-nome-campo | Char | X |
|
| Nome do campo. | |
raw-retorno | Raw |
| X |
| Campo solicitado |
Método: getRecidField
Descrição: Retorna o campo solicitado do registro que estiver posicionado. Só para campos do tipo RECID.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-nome-campo | Char | X |
|
| Nome do campo. | |
rc-retorno | Recid |
| X |
| Campo solicitado |
Método: getKey
Descrição: Retorna valores dos campos que compõem a chave do registro.
Requisitos: RowObject da BO deve estar posicionada no registro desejado.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ccod-estabel | Char | x(5) | X |
| Código do estabelecimento | |
ccod-embarq | Char | x(16) |
| X |
| Código do embarque |
icdd-id-antecip | Dec | >>>,>>>,>>9 |
| X |
| ID antecipação |
Método: goToKey
Descrição: Reposiciona registro com base no estabelecimento, embarque e id da antecipação.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ccod-estabel | Char | x(5) | X |
| Código do estabelecimento | |
ccod-embarq | Char | x(16) | X |
| Código do embarque | |
icdd-id-antecip | Dec | >>>,>>>,>>9 | X |
| ID antecipação |
Método: goToKeyTituloEmb
Descrição: Reposiciona registro com base nas informações de título e embarque.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ccod-estab-ap | Char | x(5) | X |
| Código do estabelecimento do título no contas a pagar | |
ccod-espec-docto-ap | Char | x(3) | X |
| Espécie do título do contas a pagar | |
ccod-ser-docto-ap | Char | x(5) | X |
| ID antecipação | |
ccod-tit-ap | Char | x(10) | X | Série do título do contas a pagar | ||
ccod-parc-ap | Char | x(2) | X | Parcela do título do contas a pagar | ||
icdn-emitente-ap | Inte | >>>>>>>>9 | X | Emitente do título do contas a pagar | ||
ccod-estabel | Char | x(5) | X | Estabelecimento do embarque de importação | ||
ccod-embarq | Char | x(16) | X | Embarque de importação |
Método: setConstraintEmbarqueComFaixa
Descrição: Recebe os parâmetos para abertura da query "EmbarqueComFaixa"
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ccod-embarq | Char | x(16) | X | Embarque de importação | ||
ccod-estabel | Char | x(5) | X | Estabelecimento do embarque de importação | ||
tt-param-antecip | Temp-Table | X | Temp-table com parâmetros da faixa |
Método: linkToEmbarque
Descrição: Recebe o handle da BO do acompanhamento do embarque para o relacionamento do embarque com as antecipações.
Requisitos: Posicionar no registro do histórico do embarque utilizando a BOCX230. O handle da instância dessa BO é que deverá ser passado para o linkToEmbarque.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
h-bocx230 | Handle | X | Handle da BO da tabela historico-embarque |
Método: openQueryMain
Descrição: Realiza abertura da query com todos os registros da tabela.
Requisitos: Nenhum
Parâmetros: Nenhum
Método: openQueryEmbarqueComFaixa
Descrição: Realiza a abertura da query conforme parâmetros recebidos pela execução da setConstraintEmbarqueComFaixa
Requisitos: Executar o método setConstraintEmbarqueComFaixa
Parâmetros: Nenhum
Método: openQueryByEmbarque
Descrição: Realiza a abertura da query conforme parâmetros recebidos pela execução do linkToEmbarque
Requisitos: Executar o método linkToEmbarque
Parâmetros: Nenhum
Método: validateRecord
Descrição: Validações pertinentes ao DBO
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
cType | Char | X | Recebe o tipo de validação (Create, Delete, Update) |
Método: piBuscaAntecipVincular
Descrição: Busca antecipações a vincular
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
tt-param-antecip | Temp-Table | X | Temp-table com os parâmetros para a busca das antecipações | |||
tt_tit_ap_antecip_sdo_a_vincular | Temp-Table | X | Temp-table com as antecipações a vincular. |
Método: criaRelacDocum-est
Descrição: Cria relacionamentos com o documento do recebimento (docum-est) e atualiza os campos de Data de Cotação e Valor da Cotação de acordo com a Nacionalização/Geração Documento de Entrada.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
cserie-docto | char | x(5) | X | Série do documento | ||
cnro-docto | char | x(16) | X | Número do documento | ||
icod-emitente | Inte | >>>>>>>>9 | X | Código do emitente do documento | ||
cnat-operacao | char | x(6) | X | Natureza de operação do documento | ||
ccod-estabel | Char | x(5) | X | Estabelecimento do embarque de importação | ||
ccod-embarq | Char | x(16) | X | Embarque de importação |
Método: deleteRelacDocum-est
Descrição: Elimina relacionamento da antecipação com o documento do recebimento (docum-est).
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
cserie-docto | char | x(5) | X | Série do documento | ||
cnro-docto | char | x(16) | X | Número do documento | ||
icod-emitente | Inte | >>>>>>>>9 | X | Código do emitente do documento | ||
cnat-operacao | char | x(6) | X | Natureza de operação do documento |
Método: piBuscaCotacaoDia
Descrição: Busca o valor da cotação do dia.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ccod-estabel | Char | x(5) | X | Estabelecimento do embarque de importação | ||
ccod-embarq | Char | x(16) | X | Embarque de importação | ||
ddata-cotacao | Date | 99/99/9999 | X | Data da cotação | ||
deCotacaoDia | Dec | ->>>,>>9.99999999 | X | Valor na Data da Cotação |
Método: piEliminaAntecipEmbarque
Descrição: Elimina relacionamento da antecipação com o embarque de importação.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ccod-estabel | Char | x(5) | X | Estabelecimento do embarque de importação | ||
ccod-embarq | Char | x(16) | X | Embarque de importação |
Método: piEmbarqPossuiAntecip
Descrição: Verifica se existe antecipações vinculadas ao embarque
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ccod-estabel | Char | x(5) | X | Estabelecimento do embarque de importação | ||
ccod-embarq | Char | x(16) | X | Embarque de importação | ||
lPossuiAntecip | Log | sim/não | X | Indica se possui ou não antecipação vinculada |
Método: piRetornaAntecipEmbarq
Descrição: Retorna todas as antecipações de um embarque de importação
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ccod-estabel | Char | x(5) | X | Estabelecimento do embarque de importação | ||
ccod-embarq | Char | x(16) | X | Embarque de importação | ||
RowObjectAux | Temp-Table | X | Temp-table com todas as antecipações vinculadas ao embarque de importação |
Método: piRetornaIdAntecip
Descrição: Retorna o próximo número ID a ser criado
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ccod-estabel | Char | x(5) | X | Estabelecimento do embarque de importação | ||
ccod-embarq | Char | x(16) | X | Embarque de importação | ||
de-prox-id | Dec | >>>,>>>,>>9 | X | Próximo número ID a ser criado |
Método: piVerificaNFEmbarque
Descrição: Verifica existência de nota fiscal vinculada ao embarque para habilitar ou não o botão de Relacionamentos responsável por permitir vincular antecipações ao Embarque de Importação.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ccod-estabel | Char | x(5) | X | Estabelecimento do embarque de importação | ||
ccod-embarq | Char | x(16) | X | Embarque de importação | ||
l-habilita | Log | sim/não | X | Indica se habilita ou não o relacionamento |