Histórico da Página
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico: | hbbo/boArqDocto.p |
| Include com Parâmetros: | hbbo/boArqDocto.i |
| Banco | mguni |
| Tabela | arquivo_docto |
Objetivo
Esta BO tem como objetivo a manipulação dos dados dos documentos referenciados na tabela arquivo_docto (Informações dos Arquivos dos Processos).
...
A sintaxe para executar a BO em modo persistente é:
RUN hbbo/boArqDocto.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
| RowObject | ||||
| Layout do usuário/documento | ||||
| Atributo | Tipo | Formato | Descrição | Obrigatório |
| num_id_docto | INTEGER | 999999999 | Número sequencial de identificação do documento | Sim |
| cdn |
| _tipo_proces | INTEGER | >>9 |
| Tipo do processo ao qual o documento está vinculado | Sim |
| cod_chave_proces | CHARACTER | X(40) | Código da chave do processo | Sim |
| cod |
| _usuar_docto | CHARACTER | X( |
| 12) |
| Código do usuário do |
| documento | Sim |
| dtm_criac_docto | DATETIME | 99/99/9999 HH:MM:SS.SSS | Data e hora da criação do documento | Sim |
| nom |
| _arq_docto | CHARACTER | X( |
| 100) |
| Nome do |
| arquivo |
| Sim | ||
| nom_dir_docto | CHARACTER | X( |
| 250) |
| Diretório onde está armazenado o documento | Sim |
| ind_tam_docto | CHARACTER | X( |
| 10) |
| Tamanho do arquivo | Não |
| des_docto | CHARACTER |
| X( |
| 200) | Descrição do Documento |
| Não |
tt-mla-layout-usuar-doc-origem e tt-mla-layout-usuar-doc-dest | ||||
| Layout do usuário/documento origem e destino | ||||
| 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 |
| situacao | CHARACTER | X(20) | Situação | Não |
| id-sit | INTEGER | >>9 | ID da Situação 1 - Mantido 2 - Novo 3 - Alterado 4 - Eliminado 5 - Origem 6 - Destino 7 - Erro | Não |
| r-rowid | ROWID | Rowid do registro | Não | |
| erros | CHARACTER | X(2000) | Erros ocorridos | 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 | ||
Método Negócio
userHasAnyLayout | |||
Requisito | Não há. | ||
Sintaxe | RUN userHasAnyLayout in h-handle (INPUT <pUserCode>, OUTPUT <pHasAny> ). | ||
Descrição | Retorna um valor lógico informando se usuário possui layouts | ||
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. | ||
pi-copia-substituicao-layouts | |||
Requisito | Usuário com layouts cadastrados no MLA. | ||
Sintaxe | RUN pi-copia-substituicao-layouts in h-handle (INPUT <pcOrigem>, INPUT <pcDestino>, INPUT <piOpcao>, INPUT <plSimulaAlteracao>, OUTPUT TABLE <tt-mla-layout-usuar-doc-origem>, OUTPUT TABLE <tt-mla-layout-usuar-doc-dest>). | ||
Descrição | Realiza a cópia/substituição de layouts para um usuário. | ||
Parâmetros | Tipo | Descrição | |
pcOrigem | CHARACTER | Código do usuário origem | |
| pcDestino | CHARACTER | Código do usuário destino | |
| piOpcao | INTEGER | Opção de cópia/substituição: 1 - Somente inexistentes 2 - Substituir existentes e adicionar inexistentes 3 - Substituir tudo | |
| tt-mla-layout-usuar-doc-origem | TEMP-TABLE | Contém os dados dos registros (Layouts) do usuário origem | |
| tt-mla-layout-usuar-doc-dest | TEMP-TABLE | Contém os dados dos registros (Layouts) do usuário destino | |
Retorno | Layouts do usuário origem e destino. | ||
piEliminaCamposLayout | |||
Requisito | Não há. | ||
Sintaxe | RUN piEliminaCamposLayout in h-handle (INPUT <cUser>, INPUT <iInterface>, INTPUT <iDocument> ). | ||
Descrição | Elimina os campos de layout de um Usuário, Interface e Documento | ||
Parâmetros | Tipo | Descrição | |
cUser | CHARACTER | Código do usuário | |
| iInterface | INTEGER | Interface | |
| iDocument | INTEGER | Documento | |
Retorno | Não há. | ||
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas