Linha Datasul

Árvore de páginas

 

Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

 mnbo/bomn185

 

Objetivo

Manutenir informações da tabela mgc-metod.

 

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 sintaxe para executar a API/BO em modo persistente é:

run mnbo/bomn185.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 API/BO.

 

Tabelas Temporárias

Nos atributos das tabelas temporárias de entrada e saída:

Tabela Temporária

Descrição

Entrada/Saída

(RowObject)

Tabela definida em formato like, semelhante a mgc-metod.

Abaixo os atributos que não constam na temp-table

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

r-Rowid

rowid

 

Rowid do registro

 não

2.02

Exemplo:

DEFINE TEMP-TABLE {1} NO-UNDO LIKE mgc-metod

    FIELD r-Rowid AS ROWID.

Métodos

Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

 

Método Básico

getCharField

Requisito

Nenhum   

Sintaxe

run getCharField in <h-handle> (input  pFieldName,

                                output pfieldValue)

              

Descrição

Retorna valor de campos do tipo caracter.

 

Parâmetros

Descrição

 

pFieldName

Contém o nome do campo a ser retornado

 

pFieldValue

Retorna o valor do campo solicitado

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

getDateField

Requisito

Nenhum   

Sintaxe

run getDateField in <h-handle> (input  pFieldName,

                                output pFieldValue)

              

Descrição

Retorna valor de campos do tipo data.

 

Parâmetros

Descrição

 

pFieldName

Contém o nome do campo a ser retornado

 

pFieldValue

Retorna o valor do campo solicitado

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

getDecField

Requisito

Nenhum   

Sintaxe

run getDecField in <h-handle> (input  pFieldName,

                               output pFieldValue)

              

Descrição

Retorna valor de campos do tipo decimal.

 

Parâmetros

Descrição

 

pFieldName

Contém o nome do campo a ser retornado

 

pFieldValue

Retorna o valor do campo solicitado

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

getIntField

Requisito

Nenhum   

Sintaxe

run getIntField in <h-handle> (input  PFieldName,

                               output PFieldValue)              

Descrição

Retorna valor de campos do tipo inteiro.

 

Parâmetros

Descrição

 

PFieldName

Contém o nome do campo a ser retornado

 

PFieldValue

Retorna o valor do campo solicitado

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

getKey

Requisito

Nenhum

Sintaxe

run getkey in <h-handle> (output pcod-metod)

Descrição

Retorna os valores dos campos do índice único da tabela.

 

Parâmetros

Descrição

 

pNr-ord-produ

Chave do índice único da tabela

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

getLogField

Requisito

Nenhum

Sintaxe

run getLogField in <h-handle> (input  pFieldName,

                               output pFieldValue)

Descrição

Retorna o valor do campo do registro corrente – Logical.

 

Parâmetros

Descrição

 

pFieldName

Nome do campo a ser retornado a valor

 

pFieldValue

Conteúdo do campo pesquisado

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

getRawField

Requisito

Nenhum

Sintaxe

run getRawField in <h-handle> (input  pFieldName,

                               output pFieldValue)

Descrição

Retorna o valor do  campo tipo Raw .

 

Parâmetros

Descrição

 

pFieldName

Recebe o nome do campo

 

pFieldValue

Retorna o valor do campo

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). 

getRecidField

Requisito

Nenhum

Sintaxe

run getRecidField in <h-handle> (input  pFieldName,

                                 output pFieldValue)

Descrição

Verifica se temptable RowObject está disponível.

 

Parâmetros

Descrição

 

pFieldName

Recebe o nome do campo

 

pFieldValue

Recebe o valor do campo

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

goToKey

Requisito

Nenhum

Sintaxe

run goToKey in <h-handle> (input  pCod-metod)

Descrição

Reposiciona registro com base no índice.

 

Parâmetros

Descrição

 

pCod-metod

Código do Método

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

 

Método   Negócio

atualizaModeloPlanilha

Requisito

Nenhum.

Sintaxe

run atualizaModeloPlanilha in <h-handle> (input pCodMetod,

                                          input pNrOrdProdu,

                                          input pCdEquipto)          

Descrição

Executa a api gcapi005 Atualização Planilha de Modelo

 

Parâmetros

Descrição

 

pcod-metod

Código do método

 

pNrOrdProdu

Número da Ordem de Produção

 

pCdEquipto

Código do Equipamento

 

 

 

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

CopiaPlanilha

Requisito

Nenhum

Sintaxe

run copiaPlanilha in <h-handle>(input pCodMetodoOld,

                                input pCodMetodoNew)

Descrição

 Executa a copia de planilha de método

 

Parâmetros

Descrição

 

pCodMetodoOld

 Código do Metodo a ser copiado

 

pCodMetodoNew

Código do novo Método copiado

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

geraModeloPlanilha

Requisito

Nenhum

Sintaxe

run geraModeloPlanilha in <h-handle>(input pCodMetod,

                                     input pArquivo)

Descrição

 Executa a api gcapi005

 

Parâmetros

Descrição

 

pCodMetod

 Código do Metodo

 

pArquivo

Nome do arquivo

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

CopiaPlanilha

Requisito

Nenhum

Sintaxe

run copiaPlanilha in <h-handle>(input pCodMetodoOld,

                                input pCodMetodoNew)

Descrição

 Executa a copia de planilha de método

 

Parâmetros

Descrição

 

pCodMetodoOld

 Código do Metodo a ser copiado

 

pCodMetodoNew

Código do novo Método copiado

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

openQueryDefault

Requisito

Nenhum

Sintaxe

run openQueryDefault in <h-handle>             

Descrição

Abre a query com todos os registros sem seleção.

openQueryDescricao                                         

Requisito

Nenhum

Sintaxe

run openQueryDescricao in <h-handle>             

Descrição

Abre a query selecionando os registros por faixa  de descrição.

openQueryMetodo                                              

Requisito

Nenhum

Sintaxe

run openQueryMetodo in <h-handle>             

Descrição

Abre a query selecionando os registros por faixa de código de método.

openQueryPorProcedimento                                      

Requisito

Nenhum

Sintaxe

run openQueryPorProcedimento in <h-handle>             

Descrição

Abre a query selecionando os registros por código de procedimento.

setconstraintDescricao

Requisito

Nenhum

Sintaxe

run setConstraintDescricao in <h-handle> (input cDesMetodIni,

                                          input cDesMetodFim)                                              

Descrição

Define a variável de controle da faixa da descrição  do método.

 

Parâmetros

Descrição

 

cDesmetodIni

Descrição do método  inicial

 

cDesMetodFim

Descrição do método Final

 setconstraintMetodo

Requisito

Nenhum

Sintaxe

run setConstraintMetodo in <h-handle> (input cCdCodMetodIni,

                                       input cCdodMetodFim)                          

Descrição

Define as variáveis de controle de faixa de código de método.

 

Parâmetros

Descrição

 

cCdCodMetodIni

Código do método Inicial

 

cCdoMetodFim

Código do método Final

setconstraintPorProcedimento

Requisito

Nenhum

Sintaxe

run setConstraintPorProcedimento in <h-handle> (input pcodProcedimento)              

Descrição

Define as variáveis de controle de  código de  procedimento.

 

Parâmetros

Descrição

 

pCodProcedimento

Código de procedimento

setTextoMetodo

Requisito

Nenhum

Sintaxe

run setTextoMetodo in <h-handle> (input pTextoMetodo)                           

Descrição

Define a variável referente ao texto do procedimento.

 

Parâmetros

Descrição

 

pTextoMetodo

Texto do método

validateRecord

Requisito

Nenhum

Sintaxe

run validateRecord in <h-handle>(output pType)

Descrição

Validação pertinente ao DBO para tratamento de create,delete e update.

 

Parâmetros

Descrição

 

ptype

Recebe o tipo de validação, create, delete e update

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).