Assunto
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico: | inbo/boin788.p |
Include com Parâmetros: | Inbo/boin788.i |
Banco | mgind |
Tabela | mla-verba-aprov |
Objetivo
Esta BO tem como objetivo a manipulação dos dados referentes a tabela mla-verba-aprov (Verbas liberadas).
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/boin788.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
Nos atributos das tabelas temporárias de entrada e saída:
RowObject | Entrada/Saída | ||||
Verbas liberadas | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cod-tip-doc | integer | >>9 | Documento | Sim |
|
cod-usuar | character | X(12) | Aprovador | Sim |
|
valor-verba | decimal | ->>,>>>,>>9.99 | Valor liberado | Não |
|
verba-utilizada | decimal | ->>,>>>,>>9.99 | Valor Utilizado | Não |
|
cod-usuar-lib | character | X(12) | Usuário Liberação | Não |
|
data-lib | date | 99/99/9999 | Liberação | Não |
|
periodo-ini | date | 99/99/9999 | Período Inicial | Sim |
|
periodo-fim | date | 99/99/9999 | Período Final | Não |
|
char-1 | character | x(100) |
| Não |
|
char-2 | character | x(100) |
| Não |
|
dec-1 | decimal | ->>>>>>>>>>> 9.99999999 |
| Não |
|
dec-2 | decimal | ->>>>>>>>>>> 9.99999999 |
| Não |
|
int-1 | integer | >>>>>>>>>9 |
| Não |
|
int-2 | integer | >>>>>>>>>9 |
| Não |
|
log-1 | logical | Sim/Não |
| Não |
|
log-2 | logical | Sim/Não |
| Não |
|
data-1 | date | 99/99/9999 |
| Não |
|
data-2 | date | 99/99/9999 |
| Não |
|
char-3 | character | x(100) |
| Não |
|
char-4 | character | x(100) |
| Não |
|
char-5 | character | x(100) |
| Não |
|
dec-3 | decimal | ->>>>>>>>>>> 9.99999999 |
| Não |
|
dec-4 | decimal | ->>>>>>>>>>> 9.99999999 |
| Não |
|
dec-5 | decimal | ->>>>>>>>>>> 9.99999999 |
| Não |
|
int-3 | integer | >>>>>>>>>9 |
| Não |
|
int-4 | integer | >>>>>>>>>9 |
| Não |
|
int-5 | integer | >>>>>>>>>9 |
| Não |
|
log-3 | logical | Sim/Não |
| Não |
|
log-4 | logical | yes/no |
| Não |
|
log-5 | logical | yes/no |
| Não |
|
data-3 | date | 99/99/9999 |
| Não |
|
data-4 | date | 99/99/9999 |
| Não |
|
data-5 | date | 99/99/9999 |
| Não |
|
ep-codigo | character | x(3) | Empresa | Sim |
|
cod-estabel | character | x(5) | Estabelecimento | Sim |
|
tt-mla-verba-aprov-origem | Entrada/Saída | ||||
Lista de verbas liberadas (do usuário origem – Utilizado pela procedure pi-copia-substituicao-verbas). OBS: Mesmos campos da temp-table RowObject, mais os definidos abaixo. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
Id-sit | Int |
| Situação | Não |
|
Situacao | Character | x(20) | Descrição da situação | Não |
|
r-rowid | Rowid |
| Rowid do registro | Não |
|
tt-mla-verba-aprov-destino | Entrada/Saída | ||||
Lista de verbas liberadas (do usuário destino – Utilizado pela procedure pi-copia-substituicao-verbas). OBS: Mesmos campos da temp-table tt-mla-verba-aprov-destino. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
Método 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 <character>, OUTPUT <character >, OUTPUT <integer>, OUTPUT <date >). | |
Descrição | Retorna valores dos campos do índice primário e único da tabela. | |
Parâmetros | Descrição | |
| pep-codigo pcod-estabel pcod-usuar pcod-tip-doc pperiodo-ini | Empresa Estabelecimento Usuário Documento Período Inicial |
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 <character>, INPUT <character >, INPUT <integer>, INPUT <date >). | |
Descrição | Reposiciona registro com base no índice primário e único da tabela. | |
Parâmetros | Descrição | |
| pep-codigo pcod-estabel pcod-usuar pcod-tip-doc pperiodo-ini | Empresa Estabelecimento Usuário Documento Período Inicial |
Retorno | A BO irá reposicionar no registro que foi solicitado a BO. |
goToKeyData | ||
Requisito | Query estar aberta | |
Sintaxe | RUN goToKeyData IN h-handle (INPUT <character>, INPUT <character>, INPUT <character >, INPUT <integer>, INPUT <date >). | |
Descrição | Reposiciona registro com base no índice código. | |
Parâmetros | Descrição | |
| pep-codigo pcod-estabel pcod-usuar pcod-tip-doc pperiodo | Empresa Estabelecimento Usuário Documento Período |
Retorno | A BO irá reposicionar no registro que foi solicitado a BO. |
validateRecord | ||
Requisito | Query posicionada no registro. | |
Sintaxe | Run validateRecord in handle (intpu 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
pi-copia-substituicao-verbas | ||
Requisito | Nenhum | |
Sintaxe | RUN pi-copia-substituicao-permissoes in handle (INPUT <character>, INPUT <character>, INPUT <character>, INPUT <character>, INPUT <character>, INPUT <character>, INPUT <integer>, INPUT <logical>, OUTPUT TABLE tt-mla-verba-aprov-origem, OUTPUT TABLE tt-mla-verba-aprov-destino). | |
Descrição | Copia e/ou substitui as verbas de um usuário pelas verbas de um outro. | |
Parâmetros | Descrição | |
| pcEmpresaIni | Empresa inicial a ser considerada para cópia/substituição das verbas |
| pcEmpresaFim | Empresa final a ser considerada para cópia/substituição das verbas |
| pcEstabIni | Estabelecimento inicial a ser considerado para cópia/substituição das verbas |
| pcEstabFim | Estabelecimento final a ser considerado para cópia/substituição das verbas |
| pcOrigem | Usuário origem a ser considerado para cópia/substituição das verbas |
| pcDestino | Usuário destino a ser considerado para cópia/substituição das verbas |
| plSimulaAlteracao | Indica se é apenas um simulação(cria as temp-tables porém não efetiva as alterações na base). |
| tt-mla-verba-aprov-origem | Contém os dados dos registros(Verbas Liberadas) do usuário origem. |
| tt-mla-verba-aprov-destino | Contém os dados dos registros(Verbas Liberadas) do usuário destino. |
Retorno | Retorna as temp-tables tt-mla-verba-aprov-origem e tt-mla-verba-aprov-destino com informações com as verbas liberadas. As temp-tables contem a situação da atualização de cada um dos registros. |
setDebitaVerba | ||
Requisito | Query posicionada no registro. | |
Sintaxe | RUN setDebitaVerba in handle (INPUT <decimal>).
| |
Descrição | Debita o valor da verba recebido como parâmetro da verba disponível do usuário | |
Parâmetros | Descrição | |
p-verba | Valor da verba a ser debitado | |
Retorno | Retorna OK se a execução ocorrer com sucesso e NOK no caso da ocorrência de erros. |
OpenQuery / SetConstraint / LinkTo
openQuery | ||
Requisito | Nenhum | |
Sintaxe | run openQuery in h-handle (input <character>). | |
Descrição | Faz abertuda das querys. | |
Parâmetros | Descrição | |
p-ordem | Ordenação da abertura. “main” – Abertura da query principal. | |
Retorno | Retorna um return-value com o valor “OK” se foi executado com sucesso. |
openQueryMain | ||
Requisito | Nenhum | |
Sintaxe | run openQueryStatic in h-handle (input "Main":U). | |
Descrição | Faz a abertura da tabela principal. | |
Parâmetros | Descrição | |
|
| |
Retorno |
|