Get, méthode

Permet de récupérer des propriétés basées sur les paramètres de clé d’entrée (key1, key2, ... keyn). Le paramètre de sortie est une structure contenant les propriétés de l’enregistrement qui correspondent aux paramètres de clé. Si l’interface de composant n’a qu’une seule instance (autrement dit, il n’y a pas de clé), la fonction Get ne contient aucun paramètre de clé. Voir également Find méthode.

Syntaxe

Get (key1, key2, ... keyn, properties)  
Get (key1, key2, ... keyn, getHistoryItems, properties)  

Paramètres

Paramètre	Descriptif
key	Ensemble de paramètres qui doivent exister dans la base de données du serveur ; sinon, une erreur se produit. Ces clés correspondent à l’ensemble de clés Get tel que défini pour l’interface de composant spécifique.
properties	Contient une structure complète des propriétés de l’interface de composant, qui est retournée lors de l’achèvement de l’appel.
getHistoryItems	Valeur booléenne. Si les propriétés de l’interface de composant contiennent des éléments à date d'effet en dessous du niveau 0 (c’est-à-dire, un champ clé nommé EFFDT), le getHistoryItems paramètre supplémentaire est requis. Si la valeur est : - Vrai : tous les éléments à date d'effet sont retournés sous la forme d’une séquence (qui peut être incorporée à n’importe quel niveau). Il s’agit notamment de tous les articles dont la date d’effet est passée, de l’article actuellement en vigueur, ainsi que de tous les articles dont la date d’effet est future. - False : seuls les éléments actuels et tous les éléments futurs datés effectifs sont retournés. Si des appels ultérieurs pour mettre à jour sur la même instance seront effectués, alors getHistoryItems doit être défini sur False.

Remarques

Si les propriétés de l’interface de composant contiennent des éléments obsolètes effectifs au-dessous du niveau 0 (autrement dit, un champ clé portant le nom d’EFFDT), un paramètre supplémentaire, getHistoryItemsest requis. Ce paramètre est de type Boolean. S’il est défini sur True, tous les éléments obsolètes effectifs sont retournés sous la forme d’une séquence (qui peut être incorporée dans n’importe quel niveau). Il s’agit notamment de tous les articles ayant une date d’effet passée, de l’article actuellement en vigueur, ainsi que de tous les articles ayant une date d’effet future. Si le getHistoryItems paramètre est défini sur False, seuls les éléments actuels et tous les éléments obsolètes effectifs futurs sont retournés. Si des appels ultérieurs pour mettre à jour la même instance doivent être effectués, alors la valeur de getHistoryItems doit être fixée à False. Voir aussi la méthode UpdateEx.

Si l’interface de composant n’a pas de clé, comme dans le cas où une seule instance peut exister, la Get() méthode a la forme suivante :

Get(properties)  

Pour plus d'informations sur les éléments à date d'effet, consultez la documentation PeopleSoft Enterprise.

Remarque

La méthode BizTalk Adapter for PeopleSoft Enterprise Get() est fournie si la fonction PeopleSoft Get dans l’interface du composant est activée.

Voir aussi

Annexe A : Méthodes d’interface de composant