getLetterDataElements

La classe getLetterDataElements est utilisée pour récupérer les métadonnées nécessaires pour la lettre et elle renvoie un mappage comportant les clés de chaînes suivantes :

Clé

Description

Elément de dictionnaire de données

Cette clé est mappée à une liste d’éléments de dictionnaire de données pour la lettre. Pour se différencier des autres éléments de dictionnaire de données, les dictionnaires de données de collection utilisent le marqueur de collection « [] ». Par exemple, si une personne (person) d’un élément de dictionnaire de données possède un compte (account) de type Collection possédant un numéro de compte composite (accNumber), le chemin d’accès est alors « person.account[].accNumber », où [] indique que le compte est de type Collection.

Espace réservé
Cette clé est mappée à une liste de variables (List<Variable>) qui sont utilisées dans la lettre et pour lesquelles il faut fournir des données. Toute variable d’espace réservé comportant la liaison suivante dans la lettre est ajoutée à cette liste :

  • Variables d’espace réservé liées au type User (utilisateur).

  • Variables d’espace liées au dictionnaire de données de type non protégé dans la lettre

Toute variable d’espace réservé liée au type Literal, Variable, Field, Content ou Data Dictionary (protégé) n’est pas ajoutée à cette liste.

Champ
Cette clé est mappée à une liste d’objets de champ Filds (List<Field>) utilisés dans la lettre et pour lesquels il faut fournir des données. Tout champ comportant la liaison suivante dans la lettre est ajouté à cette liste :

  • Champ lié au type User

  • Champ lié au dictionnaire de données de type non protégé dans la lettre

Tout champ lié au type Literal, Variable, Content, Ignore ou Data Dictionary (protégé) n’est pas ajouté à cette liste.
La syntaxe getLetterDataElements se présente comme suit :
public Map<String,List> getLetterDataElements(String letterID) throws ICCException;