wcService.declare (initProperties)

La fonction wcService.declare déclare un nouveau service AJAX avec l'ID spécifié. Dans HCL Commerce, un service est une URL de serveur qui crée, met à jour, supprime un objet serveur ou effectue un autre traitement sur le serveur. Au besoin, une URL de Transaction server est appelée en utilisant AJAX dans le code JavaScript. Lorsque le service est exécuté correctement, un objet JSON qui contient toutes les propriétés adaptatives de la demande d'URL est renvoyé pour la fonction JavaScript définie successHandler (réponse d'opération réussie) ou failureHandler (réponse d'échec de l'opération). De plus, un WCTopic.publish est envoyé à tout programme d'écoute inscrit si le service termine son opération correctement. Dans ce cas, les événements WCTopic.subscribe qui écoutent le sujet spécifié seront déclenchés.

Exemple

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.");
   }

});

Paramètres

initProperties: (Objet) Contient les paramètres d'initialisation.
id: (String) L'ID unique de ce service.
actionId: (Chaîne) Identificateur de l'action effectuée par ce service. Cette valeur est utilisée comme partie du nom du sujet dans l'événement de changement de modèle. Le nom de l'événement de changement de modèle est au format suivant : modelChanged/actionId...
url: (Chaîne) URL de ce service.
formId: (Chaîne) L'ID de l'élément de formulaire posté à l'URL. Il n'est toutefois pas indispensable d'associer un service à un élément de formulaire.
successHandler: function (serviceResponse): Récapitulatif : exécute un traitement après une invocation réussie du service.; Description : cette fonction est appelée après une invocation réussie du service afin de permettre tout traitement post-service. L'implémentation par défaut n'effectue aucun traitement post-service. Il est possible de remplacer cette fonction par une autre, passée en paramètre avec l'objet initProperties lors de la construction du service.; serviceResponse: (Objet) L'objet réponse du service est l'objet JSON renvoyé par l'invocation du service.
failureHandler: function (serviceResponse): Récapitulatif : exécute un traitement après une invocation manquée du service.; Description : cette fonction est appelée après une invocation manquée du service afin d'assurer tout traitement d'erreur. L'implémentation par défaut alerte l'utilisateur avec le message d'erreur situé dans l'objet de réponse du service. Il est possible de remplacer cette fonction par une autre, passée en paramètre avec l'objet initProperties lors de la construction du service.; serviceResponse: (Objet) L'objet réponse du service est l'objet JSON renvoyé par l'invocation du service.