wcService.declare (initProperties)

La función wcService.declare declara un nuevo servicio AJAX con el ID especificado. En HCL Commerce, un servicio es un URL de servidor que realiza la creación, actualización, eliminación u otro proceso de un objeto de servidor. Cuando sea necesario, se llama a un URL de Transaction server utilizando AJAX el el código JavaScript. Cuando el servicio se completa correctamente, el objet JSON que contiene todas las propiedades de respuesta de la solicitud de URL se devuelve a successHandler (la respuesta que indica éxito) o a failureHandler (la respuesta que indica error) definidos en la función JavaScript. Además, se envía un WCTopic.publish a cualquier oyente suscrito si el servicio finaliza correctamente. En este caso, se desencadenarán los sucesos WCTopic.subscribe que escuchan el tema especificado.

Ejemplo

wcService.declare({
   id: "getCatalogEntryDetailsSA",
   actionId: "getCatalogEntryDetailsSA",
   url: getAbsoluteURL() + appendWcCommonRequestParameters("GetCatalogEntryDetailsByIDView"),
   formId: "",
   successHandler: function (serviceResponse, ioArgs) {
     shoppingActionsJS.displayPriceServiceResponse(serviceResponse, ioArgs);
   },   
   failureHandler: function (serviceResponse, ioArgs) {
      console.debug("ShoppingActions.changePrice: Unexpected error occurred during an xhrPost request.");
   }

});

Parámetros

initProperties
(Objeto) Contiene cualquiera de los parámetros de inicialización.
id
(Serie) ID exclusivo de este servicio.
actionId
(Serie) Identificador de la acción que realiza este servicio. Este valor se utiliza en la creación del nombre del tema correspondiente al suceso de modelo cambiado. El nombre del suceso de modelo cambiado tiene este formato: modelChanged/actionId .
url
(Serie) El URL de este servicio.
formId
(Serie) ID del elemento de formulario que se publica en el URL. Sin embargo, no es necesario asociar un servicio con un elemento de formulario.
successHandler: function (serviceResponse)
Resumen: Procesos después de una invocación de servicio satisfactoria.
Descripción: Se llama a esta función después de una invocación de servicio satisfactoria para permitir cualquier proceso posterior al servicio. La implementación predeterminada no realiza ningún proceso posterior al servicio. Esta función puede sustituirse pasando una versión nueva con el objeto initProperties cuando se crea el servicio.
serviceResponse: (Object) El objeto de respuesta del servicio es el objeto JSON que devuelve la invocación del servicio.
failureHandler: function (serviceResponse)
Resumen: Procesos después de una invocación de servicio fallida.
Descripción: Se llama a esta función después de una invocación de servicio fallida para manejar cualquier proceso de error. La implementación predeterminada alerta al usuario con el mensaje de error que se encuentra en el objeto de respuesta de servicio. Esta función puede sustituirse pasando una versión nueva con el objeto initProperties cuando se crea el servicio.
serviceResponse: (Object) El objeto de respuesta del servicio es el objeto JSON que devuelve la invocación del servicio.