source: versions/3.5.201/Jav_CO/Description fonctions XPath.xml @ 11491

Revision 11491, 46.4 KB checked in by sys, 4 years ago (diff)

Ajout fonction xpath formatStr()
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!--
3 * LICENCE[[
4 * Version: MPL 1.1/GPL 2.0/LGPL 2.1/CeCILL 2.O
5 *
6 * The contents of this file are subject to the Mozilla Public License Version
7 * 1.1 (the "License"); you may not use this file except in compliance with
8 * the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is utc.fr code.
16 *
17 * The Initial Developer of the Original Code is
18 * Universite de Technologie de Compiegne.
19 *
20 * Portions created by the Initial Developer are Copyright (C) 2005
21 * the Initial Developer. All Rights Reserved.
22 *
23 * Contributor(s):
24 *
25 *
26 * Alternatively, the contents of this file may be used under the terms of
27 * either of the GNU General Public License Version 2 or later (the "GPL"),
28 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
29 * or the CeCILL Licence Version 2.0 (http://www.cecill.info/licences.en.html),
30 * in which case the provisions of the GPL, the LGPL or the CeCILL are applicable
31 * instead of those above. If you wish to allow use of your version of this file
32 * only under the terms of either the GPL or the LGPL, and not to allow others
33 * to use your version of this file under the terms of the MPL, indicate your
34 * decision by deleting the provisions above and replace them with the notice
35 * and other provisions required by the GPL or the LGPL. If you do not delete
36 * the provisions above, a recipient may use your version of this file under
37 * the terms of any one of the MPL, the GPL, the LGPL or the CeCILL.
38 * ]]LICENCE
39  -->
40
41<fonctionsxpath version="3">
42        <!-- DEFINITION DES PARAMETRES -->
43        <defParametre nom="pAgent" resume="Référence un agent.">
44                <details>
45                        Attention SCENARI utilise 2 implémentations XSL. L'implémentation DOM est utilisée
46                        pendant les phases de compilation des feuilles de comportements et d'execution des
47                        agents. L'implémentation DTM est utilisée dans 2 cas :
48                        - les XSL executées via l'interface graphique.
49                        - les XSL executées dans les agents "valeur" définies dans les balises "transformationxsl".
50                       
51                        Implementation DOM : L'agent est contenu dans un objet de type XNodeSet.
52                        Implémentation DTM : L'agent est contenu dans un objet de type XObject.
53                       
54                        L'implémentation DTM interdit de naviguer dans le réseau d'agents via la navigation XPath. Il
55                        est obligatoire de passer par les "path d'agents" spécfiées en chaines de caractères.
56                </details>
57        </defParametre>
58        <defParametre nom="pDialog" resume="Référence un dialogue."/>
59        <defParametre nom="pPath" resume="Chaine string représentant un chemin d'accès à un dialogue, un agent ou un service."/>
60        <defParametre nom="pRefDialog" resume="Référence un dialogue via un path ou un objet dialogue directement.">
61                <details>
62                        Un paramètre de type 'pRefDialog' permet de retourner un dialogue dans les cas suivants :
63                                 * si le paramètre est un dialogue, ce dernier est retourné.
64                                 * si le paramètre est de type string, il est interprété comme un path relatif
65                                    au dialogue par défaut du contexte. Null est retourné si aucun dialogue
66                                    n'est trouvé par rapport à ce chemin relatif.
67                        Dans tous les autres cas, Null est retourné.
68                </details>
69        </defParametre>
70        <defParametre nom="pRefDialogDefaut" resume="Référence un dialogue via un path ou un objet dialogue directement et retourne le dialogue par défaut du contexte si non trouvé.">
71                <details>
72                        Un paramètre de type 'pRefDialogDefaut' permet de retourner un dialogue dans les cas suivants :
73                                 * si le paramètre est un dialogue, ce dernier est retourné.
74                                 * si le paramètre est de type string, il est interprété comme un path relatif
75                                    au dialogue par défaut du contexte. Null est retourné si aucun dialogue
76                                    n'est trouvé par rapport à ce chemin relatif.
77                        Dans tous les autres cas, le dialogue par défaut du contexte est retourné.
78                </details>
79        </defParametre>
80        <defParametre nom="pRefAgent" resume="Référence un agent via un objet dialogue, un path ou un objet agent directement.">
81                <details>
82                        Un paramètre de type 'pRefAgent' permet de retourner un agent dans les cas suivants :
83                                 * si le paramètre est un dialogue d'agent, l'agent du dialogue est retourné.
84                                 * si le paramètre est un agent, ce dernier est retourné.
85                                 * si le paramètre est de type string, il est interprété comme un path relatif
86                                    à l'agent par défaut du contexte. Null est retourné si aucun agent
87                                    n'est trouvé par rapport à ce chemin relatif.
88                        Dans tous les autres cas, Null est retourné.
89                </details>
90        </defParametre>
91        <defParametre nom="pRefAgentDefaut" resume="Référence un agent via un objet dialogue, un path ou un objet agent directement et retourne l'agent par défaut du contexte si non trouvé.">
92                <details>
93                        Un paramètre de type 'pRefAgentDefaut' permet de retourner un agent dans les cas suivants :
94                                 * si le paramètre est un dialogue d'agent, l'agent du dialogue est retourné.
95                                 * si le paramètre est un agent, ce dernier est retourné.
96                                 * si le paramètre est de type string, il est interprété comme un path relatif
97                                    à l'agent par défaut du contexte. Null est retourné si aucun agent
98                                    n'est trouvé par rapport à ce chemin relatif.
99                        Dans tous les autres cas, l'agent par défaut du contexte est retourné.
100                </details>
101        </defParametre>
102        <defParametre nom="pRefService" resume="Référence un service via un objet dialogue, un path ou un objet service directement.">
103                <details>
104                        Un paramètre de type 'pRefService' permet de retourner un service dans les cas suivants :
105                                 * si le paramètre est un dialogue de service, le service du dialogue est retourné.
106                                 * si le paramètre est un service, ce dernier est retourné.
107                                 * si le paramètre est de type string, il est interprété comme un path relatif
108                                    au DIALOGUE par défaut du contexte. Null est retourné si aucun service
109                                    n'est trouvé par rapport à ce chemin relatif.
110                        Dans tous les autres cas, Null est retourné.
111                </details>
112        </defParametre>
113        <defParametre nom="pRefServiceDefaut" resume="Référence un service via un objet dialogue, un path ou un objet service directement et retourne le service par défaut du contexte si non trouvé.">
114                <details>
115                        Un paramètre de type 'pRefService' permet de retourner un service dans les cas suivants :
116                                 * si le paramètre est un dialogue de service, le service du dialogue est retourné.
117                                 * si le paramètre est un service, ce dernier est retourné.
118                                 * si le paramètre est de type string, il est interprété comme un path relatif
119                                    au DIALOGUE par défaut du contexte. Null est retourné si aucun service
120                                    n'est trouvé par rapport à ce chemin relatif.
121                        Dans tous les autres cas, le service par défaut du contexte est retourné.
122                </details>
123        </defParametre>
124
125
126
127        <!-- LIBRAIRIE DES FONCTIONS -->
128        <fonction nom="agent" resume="Retourne un objet de type Agent.">
129                <morphologie format="agent(pRefAgent) : agent" condition="1 seul paramètre">
130                        <retour type="objet Agent">
131                                <details>
132                                        Attention :
133                                        Implementation DOM : L'agent est contenu dans un XNodeSet
134                                        Implémentation DTM : L'agent est contenu dans un XObject.
135                                </details>
136                        </retour>
137                        <parametre numero="1" type="Objet Dialogue"/>
138                        <details>
139                                Résoud la référence à cet agent (voir la définition du paramètre 'pRefAgent').
140                        </details>
141                </morphologie>
142                <morphologie format="agent(pPath, pAgent) : agent" condition="2 paramètres et 2eme paramètre de type agent.">
143                        <parametre numero="1" type="pPath" resume="Path de l'agent."/>
144                        <parametre numero="2" type="pAgent" resume="Agent à partir duquel calculer l'url relative."/>
145                        <retour type="objet Agent">
146                                <details>
147                                        Attention :
148                                        Implementation DOM : L'agent est contenu dans un XNodeSet
149                                        Implémentation DTM : L'agent est contenu dans un XObject.
150                                </details>
151                        </retour>
152                        <details>
153                                Retourne l'agent en fonction du path passé en 1er paramètre résolu relativement l'agent passé en 2ème paramètre.
154                        </details>
155                </morphologie>
156                <morphologie format="agent(pPath, pDialog) : agent" condition="2 paramètres et 2eme paramètre de type dialogue.">
157                        <parametre numero="1" type="pPath" resume="Path de l'agent."/>
158                        <parametre numero="2" type="pDialog" resume="Dialogue à partir duquel calculer l'url relative.">
159                                <details>
160                                        Le dialogue doit être un dialogue d'agent (pas un dialogue de service), sinon, null est retourné.
161                                </details>
162                        </parametre>
163                        <retour type="objet Agent">
164                                <details>
165                                        Attention :
166                                        Implementation DOM : L'agent est contenu dans un XNodeSet
167                                        Implémentation DTM : L'agent est contenu dans un XObject.
168                                </details>
169                        </retour>
170                        <details>
171                                Retourne l'agent en fonction du path passé en 1er paramètre résolu relativement au dialogue passé en 2ème paramètre.
172                        </details>
173                </morphologie>
174        </fonction>
175        <fonction nom="agentById" resume="Retourne un objet de type Agent.">
176                <morphologie format="agentById(pId) : agent">
177                        <retour type="objet Agent">
178                                <details>
179                                        Attention :
180                                        Implementation DOM : L'agent est contenu dans un XNodeSet
181                                        Implémentation DTM : L'agent est contenu dans un XObject.
182                                </details>
183                        </retour>
184                        <parametre numero="1" type="string"/>
185                        <details>
186                                Recherche l'agent dont un "idcomposant" a été spécifié avec la valeur passée en paramètre.
187                        </details>
188                </morphologie>
189        </fonction>
190        <fonction nom="dialog" resume="Retourne un objet de type Dialogue.">
191                <morphologie format="dialog(pPath, [pDialog]) : dialogue" condition="Parametre 1 de type 'pPath'">
192                        <parametre numero="1" type="pPath" resume="Path du dialogue."/>
193                        <parametre numero="2" optionnel="oui" type="pDialog" resume="Dialogue à partir duquel le chemin relatif est calculé et le nouveau dialogue est construit."/>
194                        <retour type="objet Dialogue"/>
195                        <details>
196                                Retourne le dialogue en fonction du chemin passé en 1er paramètre.
197                                Si le 2ème paramètre est un objet Dialogue, le path est résolu relativement à ce dialogue,
198                                sinon, le path est résolu relativement au dialogue par défaut du contexte.
199                                Le dialogue précédent est le dialogue par défaut du contexte si il n'est pas précisé en paramètre 2.
200                        </details>
201                </morphologie>
202                <morphologie format="dialog(pAgent, [pDialog]) : dialogue" condition="Parametre 1 de type 'pAgent'">
203                        <parametre numero="1" type="pAgent"/>
204                        <parametre numero="2" optionnel="oui" type="pDialog" resume="Dialogue précédent a partir duquel le nouveau dialogue est construit."/>
205                        <retour type="objet Dialogue"/>
206                        <details>
207                                Retourne un nouveau dialogue pour cet agent. Le dialogue précédent est le dialogue par défaut du contexte si il n'est pas précisé en paramètre 2.
208                        </details>
209                </morphologie>
210                <morphologie format="dialog(pService, [pDialog]) : dialogue" condition="Parametre 1 de type 'pService'">
211                        <parametre numero="1" type="pService"/>
212                        <parametre numero="2" optionnel="oui" type="pDialog" resume="Dialogue précédent a partir duquel le nouveau dialogue est construit."/>
213                        <retour type="objet Dialogue"/>
214                        <details>
215                                Retourne un nouveau dialogue pour ce service. Le dialogue précédent est le dialogue par défaut du contexte si il n'est pas précisé en paramètre 2.
216                        </details>
217                </morphologie>
218        </fonction>
219        <!--
220        <fonction nom="service" resume="Retourne un objet de type Service.">
221                <morphologie format="service(pDialog) : service" condition="Parametre 1 de type objet Dialogue" resume="Retourne le service du dialogue passé en paramètre.">
222                        <parametre numero="1" type="pDialog"/>
223                        <retour type="objet Service"/>
224                </morphologie>
225                <morphologie format="service(pUrl, [pDialog]) : service" condition="Parametre 1 de type String" resume="Retourne le service correspondant à l'url passé en paramètre.">
226                        <parametre numero="1" type="String" resume="Url du service."/>
227                        <parametre numero="2" optionnel="oui" type="pDialog" resume="Dialogue à partir duquel l'url relative du service est calculée."/>
228                        <retour type="objet Service"/>
229                        <details>
230                                Si le paramètre 2 n'est pas spécifié, l'url est calculée par rapport au dialogue par défaut.
231                        </details>
232                </morphologie>
233        </fonction>
234        -->
235        <fonction nom="resultatAgent" resume="Calcule le résultat d'un agent.">
236                <details>
237                        Le dialogue utilisé pour calculer le résultat est toujours le dialogue par défaut (voir la fonction 'resultatDialogue()' pour calculer un résultat sur un autre dialogue).
238                </details>
239                <morphologie format="resultatAgent(pRefAgent, [pArguments]) : string">
240                        <parametre numero="1" type="pRefAgent"/>
241                        <parametre numero="2" optionnel="oui" type="objet" resume="Argument passé pour le calcul du résultat de l'agent.">
242                                <details>
243                                        Le format de l'argument est libre (String, nodeset, objet java, etc.).
244                                </details>
245                        </parametre>
246                        <retour type="String"/>
247                </morphologie>
248        </fonction>
249        <fonction nom="resultatDialogue" resume="Calcule le résultat de l'agent ou du service d'un dialogue.">
250                <details>
251                        Le résultat est toujours calculé avec le service ou l'agent du dialogue considéré par cette fonction.
252                </details>
253                <morphologie format="resultatDialogue(pRefDialogue, [pArguments]) : string" >
254                        <parametre numero="1" type="pRefDialogue"/>
255                        <parametre numero="2" optionnel="oui" type="objet" resume="Argument passé pour le calcul du résultat de l'agent ou du service du dialogue.">
256                                <details>
257                                        Le format de l'argument est libre (String, nodeset, objet java, etc.).
258                                </details>
259                        </parametre>
260                        <retour type="String"/>
261                </morphologie>
262        </fonction>
263        <fonction nom="resultatService" resume="Calcule le résultat d'un service.">
264                <details>
265                        Le dialogue utilisé pour calculer le résultat est toujours le dialogue par défaut (voir la fonction 'resultatDialogue()' pour calculer un résultat sur un autre dialogue).
266                </details>
267                <morphologie format="resultatService(pRefService, [pArguments]) : string">
268                        <parametre numero="1" type="pRefService"/>
269                        <parametre numero="2" optionnel="oui" type="objet" resume="Argument passé pour le calcul du résultat du service.">
270                                <details>
271                                        Le format de l'argument est libre (String, nodeset, objet java, etc.).
272                                </details>
273                        </parametre>
274                        <retour type="String"/>
275                </morphologie>
276        </fonction>
277        <fonction nom="resultat" resume="Calcule le résultat d'un agent ou d'un service.">
278                <morphologie format="resultat(pAgent, pDialog, [pArguments]) : string" condition="1er paramètre de type pAgent">
279                        <parametre numero="1" type="pAgent"/>
280                        <parametre numero="2" type="pDialog"/>
281                        <parametre numero="3" optionnel="oui" type="objet" resume="Argument passé pour le calcul du résultat de l'agent.">
282                                <details>
283                                        Le format de l'argument est libre (String, nodeset, objet java, etc.).
284                                </details>
285                        </parametre>
286                        <retour type="String"/>
287                        <details>
288                                Permet le cacul d'un résultat en spécifiant explicitement l'agent et le dialogue à partir duquel réaliser le caclul.
289                        </details>
290                </morphologie>
291                <morphologie format="resultat(pService, pDialog, [pArguments]) : string"  condition="1er paramètre de type pService">
292                        <parametre numero="1" type="pService"/>
293                        <parametre numero="2" type="pDialog"/>
294                        <parametre numero="3" optionnel="oui" type="objet" resume="Argument passé pour le calcul du résultat de l'agent.">
295                                <details>
296                                        Le format de l'argument est libre (String, nodeset, objet java, etc.).
297                                </details>
298                        </parametre>
299                        <retour type="String"/>
300                        <details>
301                                Permet le cacul d'un résultat en spécifiant explicitement le service et le dialogue à partir duquel réaliser le caclul.
302                        </details>
303                </morphologie>
304        </fonction>
305        <fonction nom="computeNodeAgent" resume="Calcule et retourne un Dom Node à partir d'un agent.">
306                <details>
307                        Le dialogue utilisé pour calculer le résultat est toujours le dialogue par défaut
308                        (voir la fonction 'computeNodeDialog()' pour calculer un résultat sur un autre dialogue).
309                </details>
310                <morphologie format="computeNodeAgent(pRefAgent, [pArguments]) : nodeSet">
311                        <parametre numero="1" type="pRefAgent"/>
312                        <parametre numero="2" optionnel="oui" type="objet" resume="Argument passé pour le calcul de cet agent.">
313                                <details>
314                                        Le format de l'argument est libre (String, nodeset, objet java, etc.).
315                                </details>
316                        </parametre>
317                        <retour type="NodeSet"/>
318                </morphologie>
319        </fonction>
320        <fonction nom="getDialogVar" resume="Récupère une variable de dialogue.">
321                <details>
322                        Retoure une variable du dialogue.
323                </details>
324                <morphologie format="getDialogVar(pKey, [pDialog]) : object" >
325                        <parametre numero="1" type="string" description="clé de la variable"/>
326                        <parametre numero="2" optionnel="oui" type="pDialog"/>
327                        <retour type="object" description="la valeur de la variable"/>
328                </morphologie>
329        </fonction>
330        <fonction nom="setDialogVar" resume="Affecte une variable de dialogue.">
331                <details>
332                        Affecte une variable du dialogue et retourne la valeur affectée.
333                </details>
334                <morphologie format="setDialogVar(pKey, pValue, [pDialog]) : object" >
335                        <parametre numero="1" type="string" description="clé de la variable"/>
336                        <parametre numero="2" type="object" description="valeur de la variable"/>
337                        <parametre numero="3" optionnel="oui" type="pDialog"/>
338                        <retour type="object" description="la valeur affectée"/>
339                </morphologie>
340        </fonction>
341        <fonction nom="removeDialogVar" resume="Supprime une variable de dialogue.">
342                <details>
343                        Supprime une variable du dialogue.
344                </details>
345                <morphologie format="removeDialogVar(pKey, [pDialog])" >
346                        <parametre numero="1" type="string" description="clé de la variable"/>
347                        <parametre numero="2" optionnel="oui" type="pDialog"/>
348                </morphologie>
349        </fonction>
350        <fonction nom="agentsLies" resume="Retourne un NodeSet des agents liés à un autre agent.">
351                <morphologie format="agentsLies(pRefAgent, [pCriteres]) : nodeset/List">
352                        <parametre numero="1" type="pRefAgent"/>
353                        <parametre numero="2" optionnel="oui" type="objet" resume="Critères de sélection des agents liés.">
354                                <details>
355                                        Le format des critères dépend de l'agent.
356                                </details>
357                        </parametre>
358                        <retour type="NodeSet / Liste d'agents">
359                                <details>
360                                        Dans le cadre des XSL de l'IHM (avec Xalan), une java.util.List est retournée.
361                                </details>
362                        </retour>
363                        <details>
364                                Le dialogue utilisé pour calculer les agents liés est toujours le dialogue par défaut du contexte.
365                        </details>
366                </morphologie>
367        </fonction>
368        <fonction nom="agentsHier" resume="Retourne un NodeSet/Liste des agents de la hiérarchie du dialogue passé en paramètre.">
369                <morphologie format="agentsHier(pDialog) : nodeset/List">
370                        <parametre numero="1" type="pDialog" resume="Dialogue à partir duquel chercher les agents de la hiérarchie."/>
371                        <retour type="NodeSet/Liste d'agents">
372                                <details>
373                                        Dans le cadre des XSL de l'IHM (avec Xalan), une java.util.List est retournée.
374                                </details>
375                        </retour>
376                        <details>
377                                Note : l'agent du dialogue lui-même ne fait pas parti du résultat.
378                                Exemple : agentsHier($vDialog), agentsHier(dialog(...))
379                        </details>
380                </morphologie>
381        </fonction>
382        <fonction nom="agentsParType" resume="Retourne un NodeSet des agents présents dans le contexte du dialogue passé en paramètre et dont le code du composant-type est égal au type passé en paramètre.">
383                <morphologie format="agentsParType(pDialogue, pType) : nodeset/List">
384                        <parametre numero="1" type="pDialogue" resume="Dialogue à partir duquel chercher les agents."/>
385                        <parametre numero="2" type="string" resume="Code du composant type"/>
386                        <retour type="NodeSet d'agents">
387                                <details>
388                                        Dans le cadre des XSL de l'IHM (avec Xalan), une java.util.List est retournée.
389                                </details>
390                        </retour>
391                        <details>
392                                Les agents considérés sont : l'agent du dialogue puis tous ses agents pères (si c'est un agent associé), suivi de chaque agent du contexte du dialogue et de tous leurs pères respectifs (en remontant la hiérarchie du contexte).
393                                Exemple : agentsParType($vDialog, 'SpSession')
394                        </details>
395                </morphologie>
396        </fonction>
397        <fonction nom="codeAgent" resume="Retourne le code de l'agent, c'est à dire le code du composant tel qu'il est défini dans la feuille de comportement.">
398                <morphologie format="codeAgent(pRefAgent) : string">
399                        <parametre numero="1" type="pRefAgent"/>
400                        <retour type="String"/>
401                </morphologie>
402        </fonction>
403        <fonction nom="typeAgent" resume="Retourne le code du composant type de l'agent, c'est à dire le code du composant-type tel qu'il est défini dans la feuille de comportement.">
404                <morphologie format="typeAgent(pRefAgent) : string">
405                        <parametre numero="1" type="pRefAgent"/>
406                        <retour type="String"/>
407                </morphologie>
408        </fonction>
409        <fonction nom="pathAgent" resume="Retourne le 'path' de l'agent, c'est à dire son url d'accès complète à partir de son agent principal.">
410                <morphologie format="pathAgent(pRefAgent) : string">
411                        <parametre numero="1" type="pRefAgent"/>
412                        <retour type="String"/>
413                        <details>
414                                Un 'path' complet d'agent commence toujours par un @.
415                                Exemples :
416                                - '@@' : agent racine de la prescription.
417                                - '@@/plan' : agent associé 'plan' de l'agent racine de la prescription.
418                                - '@agprinc1' : agent principal de code 'agprinc1'.
419                                - '@agprinc1/intro/plan' : agent associé 'plan' de l'agent associé 'intro' de l'agent principal de code 'agprinc1'.
420                        </details>
421                </morphologie>
422        </fonction>
423        <fonction nom="pathDialogAgent" resume="Retourne le 'path' du dialogue d'un agent, c'est à dire son chemin complèt avec son contexte hiérarchique.">
424                <morphologie format="pathDialogAgent(pRefDialog) : string">
425                        <parametre numero="1" type="pRefDialog"/>
426                        <retour type="String"/>
427                        <details>
428                                Le  'path' d'un dialogue d'agent commence toujours par un /@.
429                                Exemples :
430                                - '/@' : agent racine de la prescription (sans contexte hiérarchique).
431                                - '/@@/plan' : agent associé 'plan' de l'agent racine de la prescription (sans contexte hiérarchique).
432                                - '/@@/@agprinc1' : agent principal de code 'agprinc1' dans le contexte hiérarchique de l'agent racine de la prescription.
433                                - '/@@/plan/@agprinc1/intro/plan' : agent associé 'plan' de l'agent associé 'intro' de l'agent principal de code 'agprinc1' dans le contexte hiérarchique de l'agent associé 'plan' de l'agent racine de la prescription.
434                        </details>
435                </morphologie>
436        </fonction>
437        <fonction nom="actifAgent" resume="Retourne true si l'agent existe et est actif.">
438                <morphologie format="actifAgent(pRefAgent) : booleen">
439                        <parametre numero="1" type="pRefAgent"/>
440                        <retour type="Boolean"/>
441                        <details>
442                                Attention : si la donnée spécifiant la valeur 'actif' de l'agent est de niveau 'interactive', cette fonction renverra toujours vrai.
443                                Si le paramètre est un objet Dialogue, ce dernier est utilisé pour calculer la donnée.
444                        </details>
445                </morphologie>
446        </fonction>
447        <fonction nom="intituleAgent" resume="Retourne l'intitulé de l'agent, c'est à dire l'intitulé du composant tel qu'il est défini dans la feuille de comportement (tag 'intitule').">
448                <morphologie format="intituleAgent(pRefAgent) : string">
449                        <parametre numero="1" type="pRefAgent"/>
450                        <retour type="String"/>
451                </morphologie>
452        </fonction>
453        <fonction nom="descriptifAgent" resume="Retourne le descriptif de l'agent, c'est à dire le descriptif du composant tel qu'il est défini dans la feuille de comportement (tag 'descriptif').">
454                <morphologie format="descriptifAgent(pRefAgent) : string">
455                        <parametre numero="1" type="pRefAgent"/>
456                        <retour type="String"/>
457                </morphologie>
458        </fonction>
459        <fonction nom="srcElemAgent" resume="Retourne l'élément Dom à partir duquel cet agent a été créé.">
460                <details>
461                        Uniquement disponible avec l'implémentation DOM.
462                </details>
463                <morphologie format="srcElemAgent() : node-set">
464                        <details>
465                                L'élement racine de l'agent en cours est renvoyé. Cette morphologie peut aussi être utilisée en phase "statique".
466                        </details>
467                        <retour type="Object"/>
468                </morphologie>
469                <morphologie format="srcElemAgent(pRefAgent) : object">
470                        <parametre numero="1" type="pRefAgent"/>
471                        <retour type="Object"/>
472                </morphologie>
473        </fonction>
474        <fonction nom="srcFileAgent" resume="Retourne un objet java de type com.scenari.s.co.source.IHSource représentant la source XML à partir de laquelle cet agent a été créé.">
475                <morphologie format="srcFileAgent() : object">
476                        <details>
477                                La source de l'agent en cours est renvoyée. Cette morphologie peut aussi être utilisée en phase "statique"
478                                et renvoit la source du composant en cours de compilation.
479                        </details>
480                        <retour type="Object"/>
481                </morphologie>
482                <morphologie format="srcFileAgent(pRefAgent) : object">
483                        <parametre numero="1" type="pRefAgent"/>
484                        <retour type="Object"/>
485                </morphologie>
486        </fonction>
487        <fonction nom="context" resume="Retourne une variable du contexte applicatif.">
488                <morphologie format="context(pKeyContext) : object">
489                        <parametre numero="1" type="String">
490                                <details>
491                                        La liste des données disponibles dans le contexte dépend du type d'application. Exemples :
492                                        Dans le générateur, on peut passer le paramètre 'support' pour récupérer le support en cours de génération.
493                                        Dans le projet Espass, on peut passer le paramètre 'mode' pour récupérer le mode en cours.
494                                </details>
495                        </parametre>
496                        <retour type="Object"/>
497                        <details>
498                                Note : Le contexte application est obtenu via le dialogue par défaut du contexte.
499                        </details>
500                </morphologie>
501        </fonction>
502        <fonction nom="idExportAgent" resume="Retourne l'ID unique de l'agent établit par un générateur.">
503                <details>
504                        Cette fonction XPath ne peut être utilisé que dans le cadre d'un générateur.
505                </details>
506                <morphologie format="idexportAgent(pRefAgent) : string">
507                        <parametre numero="1" type="pRefAgent"/>
508                        <retour type="String"/>
509                </morphologie>
510        </fonction>
511        <fonction nom="idExportAgentHier" resume="Retourne la concaténation des ID uniques de la hierarchie des agents du dialogue suivi de l'ID unique de l'agent du dialogue séparés par des '_' (IDs établis par le générateur Scenari).">
512                <details>
513                        Cette fonction XPath ne peut être utilisée que dans le cadre d'un générateur statique.
514                        Exemple d'ID générés : "a_b_c", 'c' étant l'ID de l'agent du diaogue passé en paramètre, 'a' et 'b' sont les 2 agents de la hiérarchie du dialogue.
515                </details>
516                <morphologie format="idExportAgentHier(pRefDialog) : string">
517                        <parametre numero="1" type="pRefDialog"/>
518                        <retour type="String"/>
519                </morphologie>
520        </fonction>
521        <fonction nom="moyenne" resume="Calcule une moyenne de toutes les valeurs passée(s) en paramètre(s).">
522                <morphologie format="moyenne(pVal, [pVal,]) : Number">
523                        <parametre numero="1-N" type="Objet"/>
524                        <details>
525                                 La fonction peut contenir 1 à N paramètres.
526                                 Si un paramètre est un NodeSet, chaque node du NodeSet est pris en compte dans le calcul,
527                                 sinon le paramètre est l'élément pris en compte.
528                                 Pour chaque élément pris en compte :
529                                 - si l'élément est un Agent avec résultat, le résultat est calculé avec le dialogue par défaut.
530                                 - si l'élément est un autre node, le conteu textuel de ce node est transformé en Number (selon les règles XPath).
531                                 - si l'élément est un objet Service avec résultat, le résultat est calculé avec le dialogue par défaut.
532                                 - si l'élément est objet number, il est pris tel quel.
533                                 - si l'élément est un autre objet, la String produite par la méthode toString() de l'objet est transformé en Number (selon les règles XPath).
534                                 Si aucun élément est trouvé, la valeur NaN est renvoyée.
535                        </details>
536                </morphologie>
537        </fonction>
538        <fonction nom="somme" resume="Calcule la somme de toutes les valeurs passée(s) en paramètre(s).">
539                <morphologie format="somme(pVal, [pVal,]) : Number">
540                        <parametre numero="1-N" type="Objet"/>
541                        <details>
542                                 La fonction peut contenir 1 à N paramètres.
543                                 Si un paramètre est un NodeSet, chaque node du NodeSet est pris en compte dans le calcul,
544                                 sinon le paramètre est l'élément pris en compte.
545                                 Pour chaque élément pris en compte :
546                                 - si l'élément est un Agent avec résultat, le résultat est calculé avec le dialogue par défaut.
547                                 - si l'élément est un autre node, le conteu textuel de ce node est transformé en Number (selon les règles XPath).
548                                 - si l'élément est un objet Service avec résultat, le résultat est calculé avec le dialogue par défaut.
549                                 - si l'élément est objet number, il est pris tel quel.
550                                 - si l'élément est un autre objet, la String produite par la méthode toString() de l'objet est transformé en Number (selon les règles XPath).
551                                 Si aucun élément est trouvé, la valeur NaN est renvoyée.
552                        </details>
553                </morphologie>
554        </fonction>
555        <fonction nom="min" resume="Calcule une miniumum de toutes les valeurs passée(s) en paramètre(s).">
556                <morphologie format="min(pVal, [pVal,]) : Number">
557                        <parametre numero="1-N" type="Objet"/>
558                        <details>
559                                 La fonction peut contenir 1 à N paramètres.
560                                 Si un paramètre est un NodeSet, chaque node du NodeSet est pris en compte dans le calcul,
561                                 sinon le paramètre est l'élément pris en compte.
562                                 Pour chaque élément pris en compte :
563                                 - si l'élément est un Agent avec résultat, le résultat est calculé avec le dialogue par défaut.
564                                 - si l'élément est un autre node, le conteu textuel de ce node est transformé en Number (selon les règles XPath).
565                                 - si l'élément est un objet Service avec résultat, le résultat est calculé avec le dialogue par défaut.
566                                 - si l'élément est objet number, il est pris tel quel.
567                                 - si l'élément est un autre objet, la String produite par la méthode toString() de l'objet est transformé en Number (selon les règles XPath).
568                                 Si aucun élément est trouvé, la valeur NaN est renvoyée.
569                        </details>
570                </morphologie>
571        </fonction>
572        <fonction nom="max" resume="Calcule une maximum de toutes les valeurs passée(s) en paramètre(s).">
573                <morphologie format="max(pVal, [pVal,]) : Number">
574                        <parametre numero="1-N" type="Objet"/>
575                        <details>
576                                 La fonction peut contenir 1 à N paramètres.
577                                 Si un paramètre est un NodeSet, chaque node du NodeSet est pris en compte dans le calcul,
578                                 sinon le paramètre est l'élément pris en compte.
579                                 Pour chaque élément pris en compte :
580                                 - si l'élément est un Agent avec résultat, le résultat est calculé avec le dialogue par défaut.
581                                 - si l'élément est un autre node, le conteu textuel de ce node est transformé en Number (selon les règles XPath).
582                                 - si l'élément est un objet Service avec résultat, le résultat est calculé avec le dialogue par défaut.
583                                 - si l'élément est objet number, il est pris tel quel.
584                                 - si l'élément est un autre objet, la String produite par la méthode toString() de l'objet est transformé en Number (selon les règles XPath).
585                                 Si aucun élément est trouvé, la valeur NaN est renvoyée.
586                        </details>
587                </morphologie>
588        </fonction>
589        <fonction nom="offset" resume="Retourne la position du noeud courant ou du noeud passé en paramètre dans le contexte de son père (pas du context XSL comme la fonction position()).">
590                <morphologie format="offset(pNodeSet) : Number">
591                        <parametre numero="1" type="NodeSet" otpionnel="oui">
592                                <details>
593                                        Seul le premier noeud du NodeSet est pris en compte.
594                                </details>
595                        </parametre>
596                        <details>
597                                Si le noeud est le premier de la liste 1 est renvoyé.
598                                Si le noeud n'a pas de père 1 est renvoyé.
599                                Si aucun noeud n'est trouvé, 0 est renvoyé.
600                        </details>
601                </morphologie>
602        </fonction>
603        <fonction nom="listXml" resume="Construit une string xml respectant la DTD 'list' à partir d'un nodeset.">
604                <morphologie format="listXml(pNodeSet, [pPrefix], [pSuffix]) : String">
605                        <parametre numero="1" type="NodeSet"/>
606                        <parametre numero="2" type="String" optionnel="oui" resume="prefix à ajouter à chaque item"/>
607                        <parametre numero="3" type="String" optionnel="oui" resume="suffixe à ajouter à chaque item"/>
608                        <details>
609                                Le format de la liste est : "&lt;liste&gt;&lt;item&gt;Val1&lt;/item&gt;&lt;item&gt;Val2&lt;/item&gt;[...]&lt;/liste>".
610                                Les 2 paramètres suivants sont optionnels : de type String, ils définissent un prefix et un suffixe à ajouter à chaque item : "&lt;liste&gt;&lt;item&gt;[prefix]Val1[suffix]&lt;/item&gt;[...]&lt;/liste&gt;"
611                        </details>
612                </morphologie>
613        </fonction>
614        <fonction nom="listXmlExpr" resume="Construit une string xml respectant la DTD 'list' à partir d'un nodeset et d'une expression définissant les entrées de chaque item.">
615                <morphologie format="listXml(pNodeSet, pExpression) : String">
616                        <parametre numero="1" type="NodeSet"/>
617                        <parametre numero="2" type="pExpression" resume="Expression évaluée pour chaque entrée de pNodeSet."/>
618                        <details>
619                                Le format de la liste est : "&lt;liste&gt;&lt;item&gt;Val1&lt;/item&gt;&lt;item&gt;Val2&lt;/item&gt;[...]&lt;/liste>".
620                                Val1, Val2 [...] sont calculés en executant pExpression dans le context de chaque noeud de pNodeSet.
621                        </details>
622                </morphologie>
623        </fonction>
624        <fonction nom="concatExpr" resume="Construit une string concaténant le résultat d'une expression executé sur chaque élément dun nodeSet.">
625                <morphologie format="concatExpr(pNodeSet, pExpression, [pSeparator]) : String">
626                        <parametre numero="1" type="NodeSet"/>
627                        <parametre numero="2" type="pExpression" resume="Expression évaluée pour chaque entrée de pNodeSet."/>
628                        <parametre numero="3" type="String" optionnel="oui" resume="Séparateur ajouté entre 2 items non nuls"/>
629                </morphologie>
630        </fonction>
631        <fonction nom="testExpr" resume="Teste le résultat d'une expression executé sur chaque élément dun nodeSet.">
632                <morphologie format="testExpr(pNodeSet, pExpression, [pOperator]) : Boolean">
633                        <parametre numero="1" type="NodeSet"/>
634                        <parametre numero="2" type="pExpression" resume="Expression évaluée pour chaque entrée de pNodeSet."/>
635                        <parametre numero="3" type="String" optionnel="oui" resume="Opérateur 'or' ou 'and'."/>
636                        <details>
637                                Le traitement des entrées s'arrette dès qu'une expression a retourné true si l'opérateur est 'or'
638                                et dès qu'une expression a retourné false si l'opérateur est 'and'.
639                                Opérator par défaut : and.
640                                Si liste vide et operator "and" : retourne true.
641                                Si liste vide et operator "or" : retourne false.
642                        </details>
643                </morphologie>
644        </fonction>
645        <fonction nom="parseXml" resume="Parse un string pour le transformer en NodeSet">
646                <morphologie format="parseXml(pStringXml) : NodeSet">
647                        <parametre numero="1" type="String"/>
648                        <retour type="NodeSet" resume="Nodeset contenant un noeud de type Document."/>
649                </morphologie>
650        </fonction>
651        <fonction nom="bool2Str" resume="Transforme une expression booléenne en une string : 'true' si vrai, '' si faux.">
652                <details>
653                        Cette fonction permet de garantir : boolean(bool2Str(false())) = false().
654                        Contrairement aux fonction standard Xpath : boolean(string(false())) qui retourne true().
655                </details>
656                <morphologie format="bool2Str(pBooleanExp) : String">
657                        <parametre numero="1" type="boolean expression"/>
658                        <retour type="String" resume="'true' ou ''"/>
659                </morphologie>
660        </fonction>
661       
662        <fonction nom="chaineLargeur" resume="Retourne la largeur d'une chaine texte (en pixels) dans une police et une taille définie">
663                <morphologie format="chaineLargeur(pString, pFormat) : Nombre">
664                        <parametre numero="1" type="String" resume="Chaine pour laquelle on souhaite calculer la largeur"/>
665                        <parametre numero="2" type="String" resume="Format de la chaine : Police + Style + Taille">
666                                <details>
667                                        Le format est constitué :
668                                                - du nom de la police ('Arial', 'Verdana', ...)
669                                                - suivi du style ('italic', 'bold italic', 'bold' ou  '')
670                                                - et de la taille en points ('10', '12', ...)
671                                        Exemples : 'verdana bold italic 11', 'Arial 12', etc.
672                                </details>
673                        </parametre>
674                        <retour type="Number" resume="Nombre de pixels correspondant à la largeur cette chaine."/>
675                </morphologie>
676        </fonction>
677        <fonction nom="chaineProtegeJs" resume="Protège les caractères spéciaux (guillemet simple et double, retour à la ligne, etc.) pour que la chaine puisse être placée en guillemets dans du code javascript.">
678                <morphologie format="chaineProtegeJs(pString) : String">
679                        <parametre numero="1" type="String"/>
680                        <retour type="String" resume="Chaine protégée. Attention : ne pas oublier de placer les guillemets autour."/>
681                </morphologie>
682        </fonction>
683        <fonction nom="chaineProtegeAttHtml" resume="Protège les caractères spéciaux (guillemet double, inférieur, supérieur, retour à la ligne, etc.) pour que la chaine puisse être placée en attribut d'un noeud HTML.">
684                <details>
685                        Cette fonction XPath n'est en principe pas utile dans une XSL (protection assumée par la méthode output de la XSL). Elle peut servir dans une fonction XPath isolée.
686                </details>
687                <morphologie format="chaineProtegeAttHtml(pString) : String">
688                        <parametre numero="1" type="String"/>
689                        <retour type="String" resume="Chaine protégée. Attention : ne pas oublier de placer les guillemets doubles autour (pas de guillemets simple car les guillemets simples ne peuvent être protégés en HTML)."/>
690                </morphologie>
691        </fonction>
692        <fonction nom="escapeXslAtt" resume="Protège les accolades en les doublant pour intégrer un chaine string dans un attribut d'un élément d'une XSL pour éviter qu'il soit interpretée comme une inclusion xpath.">
693                <morphologie format="escapeXslAtt(pString) : String">
694                        <parametre numero="1" type="String"/>
695                        <retour type="String" resume="Chaine protégée avec accolades doublées."/>
696                </morphologie>
697        </fonction>
698        <fonction nom="escapeXpathString" resume="Protège les chaines de caractères insérées dans une expression Xpath.">
699                <details>
700                        Si le simple coat est utilisé comme déliminteur, tous les simple coats dans la chaine string sont doublés
701                        Si le double coat est utilisé comme déliminteur, tous les double coats dans la chaine string sont doublés
702                </details>
703                <morphologie format="escapeXpathString(pString, pUseDoubleCoat) : String">
704                        <parametre numero="1" type="String"/>
705                        <parametre numero="2" optionnel="oui" type="Boolean" resume="Si true, c'est le double coat qui sera doublé. Par défaut : fasle, c'est le simple coat qui est utilisé."/>
706                        <retour type="String" resume="Chaine protégée avec le caractère de délimiation de la chaine littérale doublée."/>
707                </morphologie>
708        </fonction>
709        <fonction nom="escapeQueryString" resume="Protège les chaines de caractères insérées un composant d'un paramètre QueryString.">
710                <morphologie format="escapeQueryString(pString) : String">
711                        <parametre numero="1" type="String"/>
712                        <retour type="String" resume="Chaine protégée."/>
713                </morphologie>
714        </fonction>
715        <fonction nom="chaineExtrait" resume="Retourne les premiers caractères de la chaine passée en paramètre tel que la largeur soit inférieur ou égal à une valeur donnée.">
716                <details>
717                        Si la largeur de la chaine entière est inférieure à la largeur passée en paramètre, la chaine entière est retournée.
718                        Sinon le plus grand nombre de caractères suivis de '...' sont retournés tel que la largeur totale soit inférieure à la largeur passée en paramètre.
719                </details>
720                <morphologie format="chaineLargeur(pString, pFormat, pLageurMax) : String">
721                        <parametre numero="1" type="String" resume="Chaine à partir de laquelle on souhaite extraire le début."/>
722                        <parametre numero="2" type="String" resume="Format de la chaine : Police + Style + Taille">
723                                <details>
724                                        Le format est constitué :
725                                                - du nom de la police ('Arial', 'Verdana', ...)
726                                                - suivi du style ('italic', 'bold italic', 'bold' ou  '')
727                                                - et de la taille en points ('10', '12', ...)
728                                        Exemples : 'verdana bold italic 11', 'Arial 12', etc.
729                                </details>
730                        </parametre>
731                        <parametre numero="3" type="Number" resume="Largeur maximale en pixel"/>
732                        <retour type="String" resume="Extrait de la chaine."/>
733                </morphologie>
734        </fonction>
735        <fonction nom="containWord" resume="Retourne true si la chaine contient un mot entier.">
736                <details>
737                        Tout caractère alphanumérique appartient au mot, les autres sont consiédérés comme des séparateurs de mots.
738                        Précisémment c'est la méthode java.lang.Character.isLetterOrDigit(pChar) qui est appelé pour savoir si le caractère
739                        appartient au mot.
740                        Cette fonction est très utile pour rechercher une classe dans un attribut class d'un noeud html par exemple ou un id dans
741                        une liste d'id séparés par des espaces.
742                </details>
743                <morphologie format="containWord(pString, pWord) : Booelan">
744                        <parametre numero="1" type="String" resume="Chaine contenant une liste de mots."/>
745                        <parametre numero="2" type="String" resume="Mot à rechercher sans caractères de séparation"/>
746                        <retour type="Boolean" resume="Si le mot entier est contenu dans la liste."/>
747                </morphologie>
748        </fonction>
749        <fonction nom="extractFileNameFromPath" resume="Extrait le nom du fichier à partir d'un URL ou d'un chemin d'accès : chaine extraite après le dernier '/' ou ':' et avant le 1er '?'.">
750                <morphologie format="extractFileNameFromPath(pString) : String">
751                        <parametre numero="1" type="String" resume="String de type URL ou chemin d'accès."/>
752                </morphologie>
753        </fonction>
754        <fonction nom="si" resume="Effectue un test conditionnel du type '(param1)? param2 : param3' c'est à dire : 'si (param1==true) alors renvoyer la valeur de param2 sinon renvoyer la valeur de param3'.">
755                <morphologie format="si(pCondition, pValeurSiVrai, pValeurSiFaux) : Objet">
756                        <parametre numero="1" type="Boolean" resume="Condition à évaluer"/>
757                        <parametre numero="2" type="Objet" resume="Valeur retournée si la condition est vérifiée"/>
758                        <parametre numero="3" type="Objet" resume="Valeur retournée si la condition n'est pas vérifiée."/>
759                </morphologie>
760        </fonction>
761        <fonction nom="execute" resume="Execute tous les membres de cette fonction et retourne null. Permet de lancer des traitement sans récupérer un éventuel résultat.">
762                <morphologie format="execute(pExp1[, pExp2][, ...]) : null">
763                        <parametre numero="N" type="Objet" resume="Execute le paramètre"/>
764                </morphologie>
765                <retour type="Null" resume="Retourne TOUJOURS null"/>
766        </fonction>
767        <fonction nom="returnFirst" resume="Evalue chaque expression jusqu'à trouver celle dont la valeur est non nulle (ie traduite en booléenne = vrai) et la retourne. Les expressions suivantes ne sont pas évaluées.">
768                <morphologie format="returnFirst(pExp1[, pExp2][, ...]) : Object">
769                        <parametre numero="N" type="Objet" resume="Execute l'expression"/>
770                </morphologie>
771                <retour type="Object" resume="Retourne la valeur de la première expression non nulle."/>
772        </fonction>
773        <fonction nom="formatStr" resume="Execute un java.util.Formatter sur un pattern.">
774                <morphologie format="formatStr(pPattern[, pParam1][, ...]) : String">
775                        <parametre numero="1" type="String" resume="Pattern au format : 'Exemple : $1%s'"/>
776                        <parametre numero="2..N" type="Objet" resume="Valeurs de remplacement (en général une string) dans le pattern."/>
777                </morphologie>
778                <retour type="String" resume="Retourne la chaine de caractère construite."/>
779        </fonction>
780        <fonction nom="getIdNode" resume="Retourne un id unique pour un noeud d'un SP/UL source. Cette fonction ne peut être appelée qu'au niveau 'statique' (phase de compilation des agents).">
781                <morphologie format="getIdNode(pNode) : String">
782                        <parametre numero="1" type="Node" resume="Element d'un document source lors de la compilation des agents."/>
783                </morphologie>
784        </fonction>
785        <fonction nom="getIdFromPath" resume="Retourne un id unique pour une source, correspondant à l'ID du noeud racine du document : getIdNode(/*).">
786                <morphologie format="getIdFromPath(pPath) : String">
787                        <parametre numero="1" type="String" resume="Chemin d'accès à une source (la syntaxe de ce path peut varier en fonction du contexte d'execution de scenari (builder, chain)...)."/>
788                </morphologie>
789        </fonction>
790        <fonction nom="translateSrcPath2DestUri" resume="Retourne une uri unique dans le système de publication pour une source.">
791                <morphologie format="translateSrcPath2DestUri([pPathSource]) : String">
792                        <parametre numero="1" type="String" resume="Chemin d'accès à une source (la syntaxe de ce path peut varier en fonction du contexte d'execution de scenari (builder, chain)...)."/>
793                </morphologie>
794        </fonction>
795
796        <fonction nom="getAttrOnCurrentElt" resume="Dans un contexte XSLT uniquement : récupère un attribut sur l'élément de l'arbre résultant en cours de construction.">
797                <morphologie format="getAttrOnCurrentElt(pQNameAttr) : String">
798                        <parametre numero="1" type="String" resume="nom qualifié de l'attribut"/>
799                        <retour type="String" resume="valeur de l'attribut si il existe, null sinon"/>
800                </morphologie>
801        </fonction>     
802       
803<!-- @deprecated utiliser plutot une fonction resultatAgent sur agent de type export avec le préfixe d'argument : pubres: suivi du SrcPath.
804        <fonction nom="translatePubPath2DestUrl" resume="Retourne une url utilisable dans le système de publication correspondnat à un fichier de l'epsace de publication qui aura été recopié.">
805                <morphologie format="translatePubPath2DestUrl(pPathSource) : String">
806                        <parametre numero="1" type="String" resume="Chemin d'accès à un fichier ou un dossier de l'espace de publication."/>
807                </morphologie>
808        </fonction>
809-->
810        <fonction nom="setEntryBuffer" resume="Ajoute une entrée dans un buffer du contexte.">
811                <morphologie format="setEntryBuffer(pKeyBuffer, pEntry, pEntryValue) : Boolean">
812                        <parametre numero="1" type="String" resume="Clé du buffer."/>
813                        <parametre numero="2" type="Object" resume="Entrée du buffer (key de l'entrée si le buffer est une Map)"/>
814                        <parametre numero="3" type="Object" resume="Valeur de l'entrée du buffer si ce dernier est une Map."/>
815                        <retour type="Boolean" resume="true si le buffer a été modifie, false sinon."/>
816                </morphologie>
817        </fonction>
818        <fonction nom="getEntryBuffer" resume="Récupère une entrée du buffer du contexte.">
819                <morphologie format="getEntryBuffer(pKeyBuffer, pEntry) : Object">
820                        <parametre numero="1" type="String" resume="Clé du buffer."/>
821                        <parametre numero="2" type="Object" resume="Entrée du buffer (key de l'entrée si le buffer est une Map)"/>
822                        <retour type="Object" resume="contenu de cette entrée de buffer."/>
823                </morphologie>
824        </fonction>
825        <fonction nom="initBuffer" resume="Initialise / Reset un buffer.">
826                <morphologie format="initBuffer(pKeyBuffer, [pBuffer])">
827                        <parametre numero="1" type="String" resume="Clé du buffer."/>
828                        <parametre numero="2" type="Object" resume="buffer (objet java) : StringBuilder, Map, List, etc. Si pBuffer est nul ou non renseigné, il est supprimé."/>
829                </morphologie>
830        </fonction>
831       
832</fonctionsxpath>
Note: See TracBrowser for help on using the repository browser.