Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | cxbo/bocx00484.p |
Include com Parâmetros: | cxbo/bocx00484.i |
Banco: | mgcex |
Tabela: | param-siscomex |
Objetivo
Esta BO tem como objetivo a manipulação dos dados referentes a tabela param-siscomex (Parâmetros Siscomex).
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/bocx00484.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.
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. |
cod-dir-histor-xml | CHARACTER | x(2000) | Diretório Histórico XML | Sim |
cod-item | CHARACTER | x(16) | Código do item | Sim |
cod-livre-1 | CHARACTER | x(500) | Código Livre 1 | Não |
cod-livre-2 | CHARACTER | x(500) | Código Livre 2 | Não |
cod-url-homol | CHARACTER | x(200) | URL do Webservice de Homologação | Sim |
cod-url-produc | CHARACTER | x(200) | URL do Webservice de Produção | Sim |
dat-livre-1 | DATE | 99/99/9999 | Data Livre 1 | Não |
dat-livre-2 | DATE | 99/99/9999 | Data Livre 2 | Não |
val-dec-livre-1 | DECIMAL | >,>>>,>>>,>>9.999999999 | Decimal Livre 1 | Não |
val-dec-livre-2 | DECIMAL | >,>>>,>>>,>>9.999999999 | Decimal Livre 2 | Não |
cdn-seq | INTEGER | 9 | Sequência | Sim |
idi-tip-ambiente | INTEGER | 9 | Ambiente de Transmissão | Sim |
num-livre-1 | INTEGER | >9 | Número Livre 1 | Não |
num-livre-2 | INTEGER | >9 | Número Livre 2 | Não |
log-histor-envio | LOGICAL | YES/NO | Mantém Histórico XML | Sim |
log-livre-1 | LOGICAL | YES/NO | Lógico Livre 1 | Não |
log-livre-2 | LOGICAL | YES/NO | Lógico Livre 2 | Não |
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 |
pFieldName | Char | X |
|
| Nome do campo. | |
pFieldValue | 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 |
pFieldName | Char | X |
|
| Nome do campo. | |
pFieldValue | 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 |
pFieldName | Char | X |
|
| Nome do campo. | |
pFieldValue | 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 |
pFieldName | Char | X |
|
| Nome do campo. | |
pFieldValue | Raw |
| X |
| Campo solicitado |
Método: getDefaults
Descrição: Retorna a temp-table RowObject com informações padrões para criação de um
novo registro.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
RowObject | Temp-table |
| X |
| Registro contendo os valores padrões para criação de um novo registro. |
Método: openQueryMain
Descrição: Realiza abertura da query com todos os registros da tabela.
Requisitos: Nenhum
Parâmetros: Nenhum
Método: getKey
Descrição: Retorna valores dos campos do índice primário.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pcdn-seq | Char | LIKE param-siscomex.cdn-seq | X |
| Retorna o valor da sequência. |
Método: goToKey
Descrição: Reposiciona registro com base no índice primário.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pcdn-seq | Char | LIKE param-siscomex.cdn-seq | X |
| Recebe o valor da sequência. |
Método: validateRecord
Descrição: Validações pertinentes ao DBO
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pType | Char | X | Recebe o tipo de validação (Create, Delete, Update) |