ABAPI013 - Trava de máximo de equipamentos conforme contrato do cliente

Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API
Nome Físico	abp/abapi013

Considerações Gerais

Objetivo

Fazer a trava do Manutenção de Frota, verificando pelo contrato do cliente qual a quantidade máxima de equipamentos que o cliente pode ter.

Funcionamento

A API roda a partir da BOFR007.p durante a inclusão de um novo equipamento, e verificar qual a quantidade de equipamentos Ativos e Motorizados, para então verificar se a quantidade de equipamentos cadastrados é maior ou igual a quantidade máxima de equipamentos, apresentando uma mensagem de erro para o usuário se não for possível incluir novo equipamento.

A sintaxe para a chamada da API é:

run abp/abapi013.p (output table RowErrors append).

Parâmetros

RowErrors = Temp-table de erros.

A execução na forma persistente não existe para esta API.

Tabelas Temporárias

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

					Entrada/Saída
Não existem temp-tables para essa API.
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução

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

Pi-inicializa
Requisito	Chamada pelo main block.
Sintaxe	run pi-inicializa in this-procedure.
Descrição	Inicializa a API, chamando a procedure verificaCadastro.
	Parâmetros	Descrição
	Não contém
Retorno	A API 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).

verificaCadastro
Requisito	Chamada pela piInicializa.
Sintaxe	Run verificaCadastro in this-procedure.
Descrição	Percorre a tabela <mab-eqpto> verificando todos os equipamentos ativos e motorizados para então verificar se a quantidade de equipamentos é maior ou igual ao máximo de equipamentos para assim travar, ou não, o cadastro de novo equipamento.
	Parâmetros	Descrição
	Não contém
Retorno	A API 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).

pialteraMaxEqpto
Requisito	Chamada pelo Main Block.
Sintaxe	Run piAlteraMaxEqpto in this-procedure.
Descrição	Como a política de licença do produto foi alterada, esse procedimento foi criado com o objetivo de sempre gravar o valor “999999999” no atributo responsável pelo número máximo de equipamentos.
	Parâmetros	Descrição
	Não contém
Retorno	A API 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).

Árvore de páginas