Show Menu
TEMAS×

Implementación de métodos SOAP

Introducción

Es posible crear métodos SOAP en JavaScript. Esta función simplemente habilita los procesos aplicativos, puede evitar desarrollar JSP y sus llamadas en los formularios.
Estos métodos SOAP se comportan del mismo modo que los definidos de forma nativa en la aplicación. Se admiten los mismos atributos: estático, solo clave y const.

Definición de una biblioteca de métodos

La creación de una biblioteca de métodos implica dos etapas:
  • La declaración del método SOAP,
  • Definición (o implementación) en JavaScript.

Declaración

Comience declarando los métodos en los esquemas (para obtener más información sobre cómo crear y editar esquemas, consulte esta sección ).
Su declaración es similar a la de los métodos nativos, excepto que debe agregar el atributo 'library' especificando el nombre de la biblioteca de métodos donde se encuentra la definición.
Este nombre coincide con el nombre (con el espacio de nombres) de la entidad de tipo 'Código JavaScript'.
Ejemplo:
El método testLog(msg) se declara en una extensión nms:Recipiente
<method name="testLog" static="true" library="cus:test">
     <parameters>
       <param name="message" type="string" inout="in"/>
     </parameters>
   </method>

El espacio de nombres y el nombre utilizados para la biblioteca son independientes del espacio de nombres y el nombre de esquema donde se encuentra la declaración.

Definición

Los métodos SOAP se implementan en forma de función JavaScript agrupada en una secuencia de comandos que representa una biblioteca.
Una biblioteca de métodos puede agrupar funciones para varios esquemas o viceversa, las funciones de un esquema se pueden definir en bibliotecas independientes.
La secuencia de comandos puede contener código que se ejecutará durante la carga inicial de la biblioteca.
1. Nombre
El nombre de la función debe cumplir el siguiente formato:
 <schema-namespace>_<schema-name>_<method-name>

Ejemplo:
La siguiente función de JavaScript es la implementación del método descrito anteriormente. Se definirá en la entidad de tipo "Código JavaScript" utilizando el nombre 'cus:test'.
function nms_recipient_testLog(message)
 {
   logInfo("*** " + message)
 }

2. Firma
La firma de la función debe incluir un argumento para cada parámetro 'in' o 'inout' de la declaración.
Casos específicos:
  • métodos no estáticos: la función debe incluir primero un argumento adicional, coincidiendo con la entidad XML pasada en forma de objeto de tipo 'xml' (E4X).
  • Métodos de tipo "solo clave": la función debe incluir primero un argumento adicional, coincidiendo con la clave pasada en forma de cadenas de caracteres.
3. Valores devueltos
La función debe devolver un valor para cada parámetro de tipo 'out' o 'inout'. Caso específico: Si el método se declara sin ninguno de los atributos 'static', 'key only' o 'const', el primer valor devuelto debe coincidir con la entidad modificada. Es posible devolver un nuevo objeto o devolver el primer parámetro modificado.
Por ejemplo:
function nms_recipient_setLastName(self, name)
 {
   self.@lastName = name
   return self
 }

Cuando se devuelven varios valores, deben mostrarse en una tabla.
Ejemplo:
function nms_recipient_getKey(self)
 {
   return [self.@firstName, self.@lastName]
 }