Skip to content

$ged.lockDocument

Description

Pose un verrou sur un document.

Syntaxe

$ged.lockDocument( nodeid [ , options ] )

Paramètres

nodeid string
Identifiant du document à verrouiller
options map

Map d'options pouvant contenir les propriétés suivantes:

connection string
Nom de connexion à utiliser. Fait référence à un name d'entrée ged.connection du config.
credentials string
Credentials de l'auteur du lock

Les propriétés reconnues par la GED Alfresco sont données ci-dessous. Veuillez également consulter la documentation d'Alfresco pour avoir plus d'informations.

timeToExpire number / string

Durée de vie du lock en secondes.

Le nœud est automatiquement déverrouillé après ce délai (si défini strictement positif). Si la propriété est non définie ou inférieure ou égale à 0, le lock n'expirera pas tant qu'on ne le déverouille pas explicitement via $ged.unlockDocument.

Plus d'infos sur la documentation d'Alfresco.

lockType string

Type de lock. Les valeurs possibles sont:

  • ALLOW_OWNER_CHANGES (par défaut) : le verrou n'autorise des changement que pour l'utilisateur ayant posé le lock
  • FULL : verrouille les modifications pour tous les utilisateurs.
lifetime boolean

Type de persistence du verrou. Les valeurs possibles sont:

  • PERSISTENT (par défaut) : Le lock est enregistré au niveau de la base de données d'Alfresco.
  • EPHEMERAL : Le lock est volatile, c'est-à-dire uniquement géré en mémoire. Par conséquent il disparaît en cas de redémarrage du serveur Alfresco et n'est pas conservé dans les sauvegardes de la base de données.

Retour

L'identifiant du nœud traité (donc la même valeur que le paramètre nodeid reçu en entrée) en cas de succès ou null en cas d'erreur.

Exemple

1
2
var nodeid = $ged.lockDocument("b8a4f19a-f7c7-4015-bf5f-3836cbd0a87c");
$logger.info(nodeid);