$doc.serialize

Description

Serialize un ou plusieurs dossiers.

Syntaxe

$doc.serialize( context [ , options ] )

Paramètres

context string / map / array

Contexte ou tableau de contextes décrivant le ou les documents à sérialiser. Le contexte en soi peut être exprimé en tant que string en clair, p.ex. "vendeur[123]}" ou en tant que map. Dans ce cas, le map doit a minima contenir une valeur pour les entrées modelName et docId.

options map

Map d'options supplémentaires décrivant le comportement de la méthode. Les options reconnues sont:

format string

Format de sérialisation attendu en sortie. Le seul format actuellement reconnus est xml, mais d'autres formats json, yaml, etc.) sont prévus à l'avenir.

Le format par défaut est xml.

ignorePolicies boolean

Flag indiquant de ne pas tenir compte des policies lors de l'ouverture.

Par défaut, les policies sont vérifiées si l'application gère des policies et si le thread courant est un thread "client", c'est-à-dire un thread initié par une requête du client. Si la méthode est invoquée par un script démarré par le scheduler, les policies ne seront pas vérifiées par défaut.

updatePolicies boolean

Flag indiquant si les policies relatives aux permissions et actions doivent être mises à jour avant de débuter la sérialisation.

Par défaut l'option est true.

fullReload boolean

Flag true/false indiquant d'effectuer un rechargement complet, y compris le tuple principal. Par défaut cette option est à false.

Retour

Retourne une chaîne de caractère contenant le ou les objets sérialisés.

Exemple

Exemple de code sérialisant tous les dossiers d'offre:

var docs = [];

for (var idOffre : $sql.mselect(`select idOffre from Offre`)) {
    docs &= { modelName: 'offre', docId: idOffre[0] };
}

var xml = $doc.serialize(docs, { ignorePolicies: true});
var file = $file.write($file.create("C:/Temp/docs.xml"), xml);