Balise : getData

La balise wcf:getData extrait les objets de données depuis un service HCL Commerce. La balise wcf:param et les balises wcf:contextData sont des éléments de la balise wcf:getData.

Remarque : Cette balise n'est disponible que pour les magasins locaux HCL Commerce et uniquement à des fins de rétrocompatibilité. Elle n'est pas prise en charge pour une utilisation avec les magasins distants.

Informations sur la balise
Informations sur la balise	Valeur
Contenu de l'élément 'Body'	`scriptless`
Nom d'affichage	Obtenir données

Attributs

Attributs
Nom	Obligatoire	Date/heure de la requête	Type	Description
`var`	`true`	`false`	`java.lang.String`	Nom de la variable ciblée exportée à laquelle sont affectées les données extraites du service HCL Commerce. C'est-à-dire, le nom de la variable qui détiendra le résultat getData. Le type de variable est spécifié par l'attribut `type`.
`type`	`true`	`false`	`java.lang.String`	Type des données à extraire. Cette valeur doit être un nom d'interface entièrement qualifié d'objet SDO de nom devant être extrait à l'aide de la façade client configurée. Si son type est ajouté avec la notation "[]", la variable spécifiée par l'attribut `var` est un tableau. Sinon, il s'agit d'un type correspondant à la première valeur rencontrée lors de l'appel du service HCL Commerce.
`scope`	`false`	`false`	`java.lang.String`	Portée des variables spécifiées par `var` et `varShowVerb`. Les valeurs de portée valides sont `page`, `request`, `session` et `application`. La valeur par défaut est `page`.
`expression`	`false`	`true`	`java.lang.String`	Expression de recherche qui extraie les données. Doit être une expression de recherche valide pour le service de composant configuré. Cet attribut ne doit pas être spécifié lorsque l'attribut `expressionBuilder` est spécifié.
`expressionLanguage`	`false`	`true`	`java.lang.String`	Langage d'expression qui interprète la valeur de l'attribut `expression`. La valeur par défaut est `_wcf:XPath`. Cet attribut ne doit pas être spécifié lorsque l'attribut `expressionBuilder` est spécifié.
`expressionBuilder`	`false`	`true`	`java.lang.String`	Nom de générateur d'expression configuré. Le générateur d'expression compose l'expression de recherche et définit le langage d'expression. Cet attribut ne doit pas être spécifié lorsque l'attribut `expression` est spécifié. Des valeurs de paramètre nommées pour le générateur d'expression peuvent être spécifiées à l'aide de l'élément `wcf:param`. Les expressions sont définies dans le fichier get-data-config.xml de chaque composant.
`recordSetReferenceId`	`false`	`true`	`java.lang.String`	ID de référence de cette requête. La valeur de l'ID de référence peut être extraite depuis l'objet verbe Show stocké dans la variable spécifiée par l'attribut `varShowVerb`. En s'appuyant sur les paramètres de pagination comme `recordSetReferenceId` et `recordSetStartNumber`, l'ID de référence renvoie la page exacte des enregistrements à partir de l'ensemble total d'enregistrements qui sont retournés par le SQL.
`recordSetStartNumber`	`false`	`true`	`java.math.BigInteger`	Index de départ pour l'extraction de résultats depuis le jeu de résultats.
`maxItems`	`false`	`true`	`java.math.BigInteger`	Nombre d'éléments maximal à renvoyer.
`varShowVerb`	`false`	`false`	`java.lang.String`	Nom de la variable ciblée exportée qui héberge l'objet verbe `Show` extrait depuis le service HCL Commerce. Le type de la variable est `com.ibm.commerce.oagis9.datatypes.ShowType`. Le verbe `Show` contient les informations de statut suivantes au sujet du jeu de résultats : `recordSetReferenceId` - Identificateur interne du jeu de résultats de sorte qu'il puisse être résolu lors d'une requête ultérieure. `recordSetCompleteIndicator` - Indique si vous êtes parvenu à la fin du jeu de résultats. `recordSetTotal` - Nombre de résultats total dans le jeu de résultats. `recordSetCount` - Nombre de résultats renvoyés dans ce message depuis le jeu de résultats. `recordSetStartNumber` - Index de départ des résultats renvoyés dans ce message.
`varException`	`false`	`false`	`java.lang.String`	- Nom de la variable étendue exportée où l'objet d'exception est stocké. Cette valeur n'est définie que lorsqu'une exception se produit lors de l'appel du générateur d'expression ou du service HCL Commerce. Le type de la variable exportée est com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentException

Variables

Aucune variable n'est définie pour la balise wcf:getData.

Exemple

L'exemple suivant utilise la balise wcf:getData pour extraire l'objet de commande du panier d'achat en cours et l'assigne à une variable appelée "order" :

<wcf:getData 
 type="com.ibm.commerce.order.facade.datatypes.OrderType" 
 var="order" 
 expressionBuilder="findCurrentShoppingCart">
   <wcf:contextData name="storeId" data="10001" />
   <wcf:param name="accessProfile" value="WC_OrderDetailsProfile" />
</wcf:getData>