SAINET apis and documentation

Helpers

Afin d’éviter les répétitions et les opérations fastidieuses dans les templates, il existe un certain nombre de helpers qui sont injectés dans les environnements Velocity afin de faciliter la récupération et la présentation des données.

Tous les helpers ne sont pas présents dans tous les environnements. Par exemple, la variable $MAILHLP n’est injectée que dans l’environnement Velocity préparant l’envoi d’emails (UNI95).

Le helper principal, $VELOHLP est lui injecté dans tous les environnements.


VELOHLP
MAILHLP

VELOHLP

Dans tout environnement Velocity, SAINet injecte un objet utilitaire sous la variable $VELOHLP. Cette variable permet d’accéder à un grand nombre de méthodes utiles permettant de mettre en forme du texte, d’extraire des informations supplémentaires, d’injecter des images, …

getCPF(dossierId, pageId, valueFieldId) - $VELOHLP.getCPF(dossierId, pageId, valueFieldId)
Retourne la page actuellement en cours de traitement.

Cette méthode ne récupère pas la page courante au sens “dont la date est en vigueur” mais la page sur laquelle le traitement est en cours. * dossierId - Le dossier à cibler * spageId - L’identifiant de la page concernée * svalueFieldId - Le champ à récupérer

getFPF(dossierId, spageId, sorderFieldId, svalueFieldId) - $VELOHLP.getFPF(dossierId, spageId, sorderFieldId, svalueFieldId)
Retourne la valeur du champ de la première occurence de page dans le dossier spécifié.

L’ordre est défini par le champ orderFieldId. * dossierId - Le dossier à cibler * spageId - L’identifiant de la page concernée * sorderFieldId - Le champ sur lequel appliquer le tri * svalueFieldId - Le champ à récupérer

getFPF(dossierId, spageId, svalueFieldId) - $VELOHLP.getFPF(dossierId, spageId, svalueFieldId)
Retourne la valeur du champ de la première occurence de page dans le dossier spécifié.

L’ordre est défini par l’ordre de création des pages. * dossierId - Le dossier à cibler * spageId - L’identifiant de la page concernée * svalueFieldId - Le champ à récupérer

getFPF(table, dossierId, spageId, sorderFieldId, svalueFieldId) - $VELOHLP.getFPF(table, dossierId, spageId, sorderFieldId, svalueFieldId)
Retourne la valeur du champ de la première occurence de page dans le dossier spécifié.

L’ordre est défini par le champ orderFieldId. * table - Table sur laquelle l’opération s’effectue * dossierId - Le dossier à cibler * spageId - L’identifiant de la page concernée * sorderFieldId - Le champ sur lequel appliquer le tri * svalueFieldId - Le champ à récupérer

getFPF(dossierId, spageId, sorderFieldId, svalueFieldId) - $VELOHLP.getFPF(dossierId, spageId, sorderFieldId, svalueFieldId)
Retourne la valeur du champ de la dernière occurence de page dans le dossier spécifié.

L’ordre est défini par le champ orderFieldId. * dossierId - Le dossier à cibler * spageId - L’identifiant de la page concernée * sorderFieldId - Le champ sur lequel appliquer le tri * svalueFieldId - Le champ à récupérer

getFPF(dossierId, spageId, svalueFieldId) - $VELOHLP.getFPF(dossierId, spageId, svalueFieldId)
Retourne la valeur du champ de la dernière occurence de page dans le dossier spécifié.

L’ordre est défini par l’ordre de création. * dossierId - Le dossier à cibler * spageId - L’identifiant de la page concernée * svalueFieldId - Le champ à récupérer

getFPF(table, dossierId, spageId, sorderFieldId, svalueFieldId) - $VELOHLP.getFPF(table, dossierId, spageId, sorderFieldId, svalueFieldId)
Retourne la valeur du champ de la dernière occurence de page dans le dossier spécifié.

L’ordre est défini par le champ orderFieldId. * table - La table sur laquelle s’effectue l’opération * dossierId - Le dossier à cibler * spageId - L’identifiant de la page concernée * sorderFieldId - Le champ sur lequel appliquer le tri * svalueFieldId - Le champ à récupérer

getField(datafieldKey, valueKey, fieldName) - $VELOHLP.getField(datafieldKey, valueKey, fieldName)
Retourne la valeur du champ de l’entité à partir de la clé donnée.
  • datafieldKey - Le datafield de la clé (ADRDOSDOSSIER.ID_PK)
  • valueKey - La valeur de la clé (D200201)
  • fieldName - Le nom du champ (DLABEL or ADRDOSDOSSIER.DLABEL)
getEntity(datafieldPK, value) - $VELOHLP.getEntity(datafieldPK, value)
Retourne l’entité à partir de la clé spécifiée.
  • datafieldPK - Le datafield de la clé (ADRDOSDOSSIER.ID_PK)
  • value - La valeur de la clé (D200201)
getEntityFromQuery(sqlQuery, parameters…) - $VELOHLP.getEntityFromQuery(sqlQuery, parameters...)
Retourne l’entité correspondante à la requete JPQL.
  • sqlQuery - La requête JPQL.
  • parameters - Les paramètres (varargs).
getEntitiesFromQuery(sqlQuery, parameters…) - $VELOHLP.getEntitiesFromQuery(sqlQuery, parameters...)
Retourne les entités correspondantes à la requete JPQL.
  • sqlQuery - La requête JPQL.
  • parameters - Les paramètres (varargs).

MAILHLP

Cette variable contient quelques fonctions permettants d’ajouter des pièces jointes aux mails qui sont envoyés. Elles n’est injectée que pour la gestion des mails (UNI95).

addAttachment(entity) - $MAILHLP.addAttachment(entity)
Ajoute les fichiers de la note de cet enregistrement comme pièce jointe.
  • entity - L’entité.
addAttachment(entity, name) - $MAILHLP.addAttachment(entity, name)
Ajoute les fichiers de la note de cet enregistrement comme pièce jointe avec le nom spécifié.
  • entity - L’entité.
  • name - Le nom des pièces jointes. Un suffixe sera automatiquement ajouté s’il y a des duplicats.
addAttachment(pageField) - $MAILHLP.addAttachment(pageField)
Ajoute les fichiers de la note du champ de cette page comme pièce jointe.
  • pageField - Le champ de page.
addAttachment(pageField, name) - $MAILHLP.addAttachment(pageField, name)
Ajoute les fichiers de la note du champ de cette page comme pièce jointe.
  • pageField - Le champ de page.
  • name - Le nom des pièces jointes. Un suffixe sera automatiquement ajouté s’il y a des duplicats.
getAttachments() - $MAILHLP.getAttachments()
Retourne la liste des pièces jointes.