Ativa a classe e instancia objetos necessários para seu funcionamento
getError
Sintaxe
FWEAIObj():getError ()-> Caracter
Descrição
Método que retorna o último erro gerado pela classe
getJSON
Sintaxe
FWEAIObj():getJSON (nItem)-> Caracter
Descrição
Método que criar e devolve a String JSON com base no Objeto.
Para mensagem que não são do tipo batch, o nItem será ignorado.
para mensagens do tipo batch 2, não pode ser serializada para o formato de API.
para mensagens do tipo batch 1, não é possível serializar apenas 1 item.
Parâmetros
Nome
Tipo
Descrição
Default
Obrigatório
Referência
nItem
Numérico
Informa qual o Item deseja ser retornado em caso de um objeto definido com Lote. Caso em branco retornara todos os items
lAPI
Logico
Informa qual o padrão da String de saida(True para retornar no padrão de API, falso para retornar no padrão de mensagem padronizada da TOTVS)
.F.
setBatch
Sintaxe
FWEAIObj():setBatch (nBatch)-> NIL
Descrição
Define qual e se será usado lote para este objeto
Parâmetros
Nome
Tipo
Descrição
Default
Obrigatório
Referência
nBatch
Numerico
Qual o tipo do lote (1 = simple Transaction – múltiplas transações, 2 = business Transaction – uma transação)
X
NextItem
Sintaxe
FWEAIObj():NextItem()-> NIL
Descrição
Quando em Lote, prepara o Objeto para o próximo item do lote
setEvent
Sintaxe
FWEAIObj():setEvent(cEvent)-> NIL
Descrição
Define qual o evento relacionado com este Objeto
Parâmetros
Nome
Tipo
Descrição
Default
Obrigatório
Referência
cEvent
Caracteres
Evento relacionado ao Objeto
X
setHeader
Sintaxe
FWEAIObj():setHeader(cPropName,xValor)-> NIL
Descrição
Inclui uma nova propriedade no header do Objeto, caso o tipo do lote seja bussiness transaction, no header no item posicionado
Parâmetros
Nome
Tipo
Descrição
Default
Obrigatório
Referência
cPropName
Caracteres
Nome da propriedade que será definida, se não existir será criada, caso exista seu valor sera substituído
X
xValor
Indefinido
Valor que será atribuído à propriedade informada, este pode ser numérico, logico ou caractere
X
SetProp
Sintaxe
FWEAIObj():setProp(cPropName,xValor)-> NIL
Descrição
Método para criação de propriedade para o contente do Objeto, caso habilitado em lote, a propriedade será atribuída ao item corrente
Parâmetros
Nome
Tipo
Descrição
Default
Obrigatório
Referência
cPropName
Caracteres
Nome da propriedade que será definida, se não existir será criada, caso exista seu valor sera substituído
X
xValor
Indefinido
Valor que será atribuído à propriedade informada, este pode ser numérico, logico,caractere ou Array(em caso de array se a propriedade não for array, ela irá se tornar, porém se for será adicionado uma nova linha ao array).
getPropValue
Sintaxe
FWEAIObj():getPropValue(cPropName)-> xValor
Descrição
Método para retornar o valor de uma propriedade do objeto, caso em lote irá retornar do item corrente
Parâmetros
Nome
Tipo
Descrição
Default
Obrigatório
Referência
cPropName
Caracteres
Nome da propriedade que será consultada para retornar o valor
X
getEvent
Sintaxe
FWEAIObj():getEvent()-> cEvent
Descrição
Método para retornar o tipo do evento que foi definido para este objeto
getHeaderValue
Sintaxe
FWEAIObj():getHeaderValue()-> NIL
Descrição
Método para retornar o valor de uma propriedade do cabeçalho do objeto, caso o lote for business transaction irá retornar do item corrente
Parâmetros
Nome
Tipo
Descrição
Default
Obrigatório
Referência
cPropName
Caracteres
Nome da propriedade que será consultada para retornar o valor
X
loadJson
Sintaxe
FWEAIObj():loadJson(cJSON)-> NIL
Descrição
Metodo para dar carga no Objeto a partir de uma String JSON, este método era habilitar o Lote automaticamente se for necessário, e ira sobrepor os dados caso já esteja no Objeto
Parâmetros
Nome
Tipo
Descrição
Default
Obrigatório
Referência
cJSON
Caracteres
Sting JSON que será utilizada para carga do objeto(esta deve estar no padrão da mensagem padronizada).
x
convertProp
Sintaxe
FWEAIObj():convertProp(cPropName)
Descrição
Método para conversão de propriedade fornecida pelo adapter passada como array em objeto. É informado o nome da propriedade e, caso ela seja um array, o seu conteúdo é convertido.
1 comentário
Rafael Tenorio da Costa_
Sobre o método seterror, teria alguma documentação ?