Get, méthode
Cette méthode permet de récupérer les propriétés en fonction des paramètres de clé d'entrée (key1, key2, … keyn). Le paramètre sortant est une structure contenant les propriétés de l'enregistrement correspondant aux paramètres de clé. Si l’interface du composant n’a qu’un seul instance (c’est-à-dire qu’il n’y a pas de clé), la fonction Get ne contient aucun paramètre de clé. Consultez également Find, méthode.
Syntaxe
Get (key1, key2, ... keyn, properties)
Get (key1, key2, ... keyn, getHistoryItems, properties)
Paramètres
Paramètre | Description |
---|---|
key |
Ensemble de paramètres qui doit exister dans la base de données du serveur, sans quoi une erreur survient. Ces clés correspondent au jeu d’obtention de clés tel que défini pour l’interface de composant particulière. |
properties |
Contient une structure complète des propriétés de l'interface de composant, qui est renvoyée une fois l'appel terminé. |
getHistoryItems |
Valeur booléenne. Si les propriétés de l’interface de composant contiennent des éléments dont la date d’effet est inférieure au niveau 0 (c’est-à-dire un champ de clé portant le nom EFFDT), le getHistoryItems paramètre supplémentaire est requis.Si la valeur est : - True : tous les éléments datés effectifs sont retournés sous forme de séquence (qui peut être incorporée à n’importe quel niveau). à savoir tous les éléments passés, actuels et futurs. - False : seuls les éléments datés actuels et futurs sont retournés. Si les appels suivants à mettre à jour sur le même instance sont effectués, getHistoryItems la valeur doit être définie sur False. |
Remarques
Si les propriétés de l’interface de composant contiennent des éléments datés effectifs inférieurs au niveau 0 (autrement dit, un champ de clé avec le nom EFFDT), un paramètre supplémentaire, getHistoryItems
, est requis. Ce paramètre est de type booléen. S'il est défini sur True, tous les éléments ayant une date d'effet sont renvoyés en tant que séquence (qui peut être incorporée à tous les niveaux), Il s’agit de tous les éléments antérieurs datés, de l’élément daté effectif actuel, ainsi que de tous les éléments datés effectifs futurs. Si le getHistoryItems
paramètre est défini sur False, seuls les éléments datés actuels et futurs sont retournés. Si les appels suivants à mettre à jour sur le même instance doivent être effectués, getHistoryItems
la valeur doit être définie sur False. Voir aussi Méthode UpdateEx.
Si l’interface du 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 ayant une date d'effet, consultez la documentation de PeopleSoft Enterprise.
Notes
La méthode Adaptateur BizTalk pour PeopleSoft Enterprise Get()
est fournie si la fonction PeopleSoft Get
dans l’interface du composant est activée.