Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico: | inbo/boin01100.p |
| Include com Parâmetros: | Inbo/boin01100.i |
| Banco | mgind |
| Tabela | mla-layout-usuar-doc |
Objetivo
Esta BO tem como objetivo a manipulação dos dados referentes a tabela mla-layout-usuar-doc (Layouts de Usuário / Documento).
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 inbo/boin01100.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.
| RowObject | ||||
| Layout do usuário/documento | ||||
| Atributo | Tipo | Formato | Descrição | Obrigatório |
| cod-usuar | CHARACTER | x(12) | Usuário | Sim |
| cdn-docto | INTEGER | >>9 | Documento | Sim |
| idi-interfac | INTEGER | >9 | Interface | Sim |
| cod-id-campo | CHARACTER | X(80) | ID do Campo | Sim |
| idi-compon | INTEGER | >9 | Tipo Componente | Sim |
| nom-rotu-campo | CHARACTER | X(40) | Rótulo do Campo | Não |
| des-campo | CHARACTER | X(200) | Descrição do Campo | Sim |
| log-visivel | LOGICAL | Sim/Não | Visível | Sim |
| cdn-tam | INTEGER | >>9 | Tamanho | Sim |
| cdn-ord | INTEGER | >>>9 | Ordem | Sim |
| cod-entid-pai | CHARACTER | X(80) | Código Entidade Pai | Não |
| cod-livre-1 | CHARACTER | x(500) | Livre 1 | Não |
| cod-livre-2 | CHARACTER | x(500) | Livre 2 | Não |
| log-livre-1 | LOGICAL | Sim/Não | Livre 1 | Não |
| log-livre-2 | LOGICAL | Sim/Não | Livre 2 | Não |
| num-livre-1 | INTEGER | >>>>>>>>9 | Livre 1 | Não |
| num-livre-2 | INTEGER | >>>>>>>>9 | Livre 2 | Não |
| val-livre-1 | DECIMAL | ->>>>>>>>>>>9.99999999 | Livre 1 | Não |
| val-livre-2 | DECIMAL | ->>>>>>>>>>>9.99999999 | Livre 2 | Não |
| dat-livre-1 | DATE | 99/99/9999 | Livre 1 | Não |
| dat-livre-2 | DATE | 99/99/9999 | Livre 2 | Não |
Metodo Básico
Quando a BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
getCharField | ||
Requisito | Query posicionada no registro. | |
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. | |
getDateField | ||
Requisito | Query posicionada no registro. | |
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. | |
getDecField | ||
Requisito | Query posicionada no registro. | |
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. | |
getIntField | ||
Requisito | Query posicionada no registro. | |
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. | |
getLogField | ||
Requisito | Query posicionada no registro. | |
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. | |
getRawField | ||
Requisito | Query posicionada no registro. | |
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. | |
getRecidField | ||
Requisito | Query posicionada no registro. | |
Sintaxe | RUN getRecidField IN handle (INPUT <character>, OUTPUT <recid>). | |
Descrição
| Retorna valor dos campos do tipo recid | |
Parâmetros | Descrição | |
pFieldName | Nome do campo recid que será retornado o valor | |
pFieldValue | Valor contido no campo solicitado | |
Retorno | A BO irá retornar o valor contido no campo recid que foi solicitado. | |
getKey | ||
Requisito | Query posicionada no registro. | |
Sintaxe | RUN getKey IN handle (OUTPUT <character>, OUTPUT <integer>, OUTPUT <integer>, OUTPUT <character>). | |
Descrição
| Retorna valores dos campos do índice primário e único da tabela. | |
Parâmetros | Descrição | |
pcod-usuar | Código do usuário | |
| pidi-interfac | Interface | |
| pcdn-docto | Código do Documento | |
| pcod-id-campo | ID do campo | |
Retorno | A BO irá retornar o valor contido nos campos do índice primário e único da tabela. | |
goToKey | ||
Requisito | Query estar aberta. | |
Sintaxe | RUN goToKey IN h-handle (INPUT <character>, INPUT <integer>, INPUT <integer>, INPUT <character>). | |
Descrição
| Reposiciona registro com base no índice primário e único da tabela. | |
Parâmetros | Descrição | |
pcod-usuar | Código do usuário | |
| pidi-interfac | Interface | |
| pcdn-docto | Código do Documento | |
| pcod-id-campo | ID do campo | |
Retorno | A BO irá reposicionar no registro que foi solicitado. | |
validateRecord | ||
Requisito | Query posicionada no registro. | |
Sintaxe | Run validateRecord in handle (INPUT pType). | |
Descrição | Validações pertinentes ao DBO. | |
Parâmetros | Descrição | |
pType | Recebe o tipo de validação. create: Indica a criação de um registro update: Indica a atualização de um registro delete: Indica a eliminação de um registro | |
Retorno | ||
userHasAnyLayout | |||
Requisito | Retorna um valor lógico informando se usuário possui layouts | ||
Sintaxe | RUN userHasAnyLayout in h-handle (INPUT <pUserCode>, OUTPUT <pHasAny> ). | ||
Descrição | Cria/atualiza erros de integração com o Fluig | ||
Parâmetros | Tipo | Descrição | |
pUserCode | CHARACTER | Código do usuário | |
| pHasAny | LOGICAL | Indica se há layouts para o usuário | |
Retorno | Indicação se o usuário possui ou não layouts. | ||
O retorno desta procedure será "NOK" sempre que ocorrer algum erro durante o processamento, caso contrário o retorno será "OK".
Não há