Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API
Nome Físico	docapi/enapi608.p

Objetivo

Efetua as rotinas do cadastro e manipulação de imagens e documentos, associados aos itens pertencentes a estrutura de componente.

Funcionamento

A API/BO...

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 a chamada da API/BO é:

run xxx/xxapinnn.p (input-output table tt-...,

input table tt-...,

...,

...).

A execução na forma persistente ...

A sintaxe para executar a API/BO em modo persistente é:

run xxx/xxapinnn.p persistent set h-handle (input-output table tt-...,

input table tt-...,

...,

...).

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

Tabelas Temporárias

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

Tabela Temporária		Descrição				Entrada/Saída
ttFileVO/tt-file		Atributos de um documento ou imagem				Entrada
Atributo	Tipo		Formato	Descrição	Obrigatório		Evolução
sequence	Integer				Não		2.08
isMainImage	logical				Não		2.08
isDirectory	logical				Não		2.08
fileSize	Integer				Não		2.08
lastModified	date				Não		2.08
changedBy	character				Não		2.08
relativePath	character				Não		2.08
fileName	character				Não		2.08

Tabela Temporária		Descrição				Entrada/Saída
ttBooleanReturn		Retorno Lógico				Entrada
Atributo	Tipo		Formato	Descrição	Obrigatório		Evolução
booleanValue	logical				Não		2.08

Tabela Temporária		Descrição				Entrada/Saída
ttStringReturn		Retorno String				Entrada
Atributo	Tipo		Formato	Descrição	Obrigatório		Evolução
stringValue	character				Não		2.08

Métodos

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

getMainImage

Requisito	Receber o id do item
Sintaxe	getMainImage (input itemId, output table ttTTString, output table RowErrors)
Descrição	Busca a imagem principal associada a um determinado item.
	Parâmetros	Descrição
	itemId	Id do item que terá a imagem selecionada
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). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. Retorna o caminho parcial da imagem. Este caminho será concatenado com o parâmetro do catálogo, mostrando assim o caminho da imagem.

dissociateDocumentFromItem

Requisito	Id do item e id da imagem
Sintaxe	dissociateDocumentFromItem (input itemId, input documentSequence, output table RowErrors)
Descrição	Desassocia um documento de um item.
	Parâmetros	Descrição
	itemId	Id do item.
	documentSequence	Id do documento na 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). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

associateDocumentToItem

Requisito	Id do item e informações do documento a ser associado
Sintaxe	associateDocumentToItem (input itemid, input table ttfilevo, output table rowerrors)
Descrição	Exportação de ordens geradas.
	Parâmetros	Descrição
	itemId	Id do item.
	ttFileVO	VO com as informações do documento.
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). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getItemsAssociatedToImage

Requisito	Caminho da imagem e catálogo
Sintaxe	getItemsAssociatedToImage (input imagePath, input catalogPath, output table ttTTString, output table RowErrors)
Descrição	Retorna os itens associados a uma determinada imagem.
	Parâmetros	Descrição
	imagePath	Caminho da imagem.
	catalogPath	catálogo das imagens.
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). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. A BO retornará através da temp-table ttStringReturn a coleção de dados com os nomes dos itens encontrados.

setMainImage

Requisito
Sintaxe	setMainImage (input itemId, input imageSequence, output table RowErrors)
Descrição	Altera uma determinada imagem para ser a principal do item.
	Parâmetros	Descrição
	itemId	Id do item.
	imageSequence	id da tabela que liga item a arquivos
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). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

dissociateImageFromItem

Requisito
Sintaxe	dissociateImageFromItem (input itemId, input imageSequence, output table RowErrors)
Descrição	Desassocia uma imagem de um determinado item.
	Parâmetros	Descrição
	itemId	id do item.
	imageSequence	id da tabela que liga item a arquivos.
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). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

associateImageToItem

Requisito
Sintaxe	associateImageToItem (input itemId, input table ttFileVO, output table RowErrors)
Descrição	Associa um arquivo a um determinado item.
	Parâmetros	Descrição
	itemId	id do item.
	ttFileVO	V.O. contendo as informações do item a ser salvo.
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). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getItemImages

Requisito
Sintaxe	getItemImages (input itemId, output table ttFileVO, output table RowErrors)
Descrição	Busca todas as imagens atreladas a um determinado item.
	Parâmetros	Descrição
	itemId	id do item.
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). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. A BO retornará através da temp-table ttFileVO uma lista de imagens, pertencentes ao item passado por parâmetro.

getItemDocuments

Requisito
Sintaxe	getItemDocuments (input itemId, output table ttFileVO, output table RowErrors)
Descrição	Busca todos os documentos atrelados a um determinado item.
	Parâmetros	Descrição
	itemId	id do item.
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). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. A BO retornará através da temp-table ttFileVO uma lista de documentos, pertencentes ao item passado por parâmetro.

registerUploadedFile

Requisito
Sintaxe	registerUploadedFile (input catalogPath, input table ttFileVO, output table RowErrors)
Descrição	Registra na tabela docto-item o arquivo que foi armazenado no catálogo..
	Parâmetros	Descrição
	catalogPath	catálogo das imagens.
	ttFileVO	Informações do arquivo adicionado.
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). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getCatalogFiles

Requisito
Sintaxe	getCatalogFiles (input catalogPath, input relativePath, output table ttFileVO, output table RowErrors)
Descrição	Retorna todos os arquivos e diretórios do caminho especificado.
	Parâmetros	Descrição
	catalogPath	catálogo das imagens.
	relativePath	caminho relativo da imagem.
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). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. A temp-table ttFileVO é uma lista de temp-tables. Ela retorna os arquivos e diretórios pertencentes a um determinado endereço.

removeFile

Requisito
Sintaxe	removeFile (input filePath, output table RowErrors)
Descrição	Criação/alteração de Planos de Produção.
	Parâmetros	Descrição
	filePath	caminho da imagem.
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). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

Árvore de páginas

ENAPI608 - Efetua as rotinas do cadastro e manipulação de imagens e documentos, associados aos itens pertencentes a estrutura de componente