Thème "Paramètres"

   Ensemble des méthodes et macros disponibles dans le thème "Paramètres".

File getIACHome()

Récupère le répertoire correspondant au IAC_HOME du serveur de traitements (répertoire racine des composants).

Exemple :
report("IAC_HOME : [$1]", xtParam.getIACHome().getAbsolutePath());    // IAC_HOME : [/iacora]

File - Le répertoire correspondant au IAC_HOME du serveur de traitements.

1.0

void getParameter(String name)

Récupère la valeur d'un paramètre applicatif. Pour mémoire, les paramètres applicatifs peuvent être positionnés :

• Soit depuis la gestion "GPAR", pour le paramètre "QETL" ;
• Soit depuis la gestion "GMNDQIN" pour le type "QIN" ;

Exemple :

xtParam.setParameter("test","a");
report("value of parameter [test] : [$1]", xtParam.getParameter("test"));    //value of parameter [test] : [a]

String name - Nom du paramètre recherché.

String - Valeur du paramètre demandé.

1.0

void getParameter(String name, String defaultValue)

Récupère la valeur d'un paramètre applicatif. Si le paramètre n'existe pas, la valeur par défaut est retournée.
Pour mémoire, les paramètres applicatifs peuvent être positionnés :

• Soit depuis la gestion "GPAR", pour le paramètre "QETL" ;
• Soit depuis la gestion "GMNDQIN" pour le type "QIN" ;

Exemple :

report("value of test parameter : [$1]", xtParam.getParameter("test", "******"));    //value of test parameter : [*****]

String name - Nom du paramètre recherché.
String defaultValue - Valeur retournée si le paramètre n'existe pas.

String - Valeur du paramètre demandé ou la valeur par défaut si le paramètre n'existe pas.

1.0

void setParameter(String name, String value)

Crée un paramètre applicatif ou modifie sa valeur si celui-ci existe déjà.

Exemple :

xtParam.setParameter("test","a");

report("Valeur du paramètre [test] : [$1]", xtParam.getParameter("test"));

Contenu du journal fonctionnel (compte rendu)

16:55:13 Valeur du paramètre [test] : [a]

String name - Nom du paramètre.
String value - Valeur à affecter.

1.0

void removeParameter(String name)

Supprime le paramètre applicatif spécifié.

Exemple :
//Récupère le paramètre P1
String param1 = xtParam.getParameter("P1");

if (xtString.isNotEmpty(param1)) {
  //Affiche sa valeur
  report ("P1=[$1]", xtParam.getParameter("P1"));

  //Supprime le paramètre
  xtParam.removeParameter("P1");

  //Affiche de nouveau sa valeur
  report ("P1 (after remove) =[$1]", xtParam.getParameter("P1"));
}

Contenu du fichier journal fonctionnel (compte rendu)

16:45:10 P1=[Valeur de P1]
16:45:10 P1 (after remove) =[null]

String name - Nom du paramètre à supprimer.

XTException - Si la suppression du paramètre n'est pas possible.

1.0