org.nuxeo.scenari.model
Interface ScenariNode

All Known Subinterfaces:

ScenariItem, ScenariSpace, ScenariWorkspace

public interface ScenariNode

Représente un noeud Scenari correspondant à un document Nuxeo.

Nested Class Summary

static class

ScenariNode.VersionOrigin

Method Summary

void	createNetVersion(String pComment, Map<String,Object> pOptions) Créé une nouvelle version à partir cet item racine.
org.nuxeo.ecm.core.api.DocumentModel	getDocumentModel() Objet de l'API Nuxeo représentant ce noeud.
String	getId() Id nuxeo de ce noeud.
List<ScenariLink>	getLinks() Retourne les liens vers d'autres items de cet item.
String	getLiveId() Id du "live" document auquel appartient cette version.
String	getModificationUser() Compte de l'utilisateur ayant réalisé la dernière modification.
String	getName() Fragment terminal du chemin correspondant au nom du fichier ou du dossier.
List<ScenariItem>	getNetVersions() Retourne la liste des versions dont cet item a été la racine.
String	getPath() Chemin de ce noeud (différent de l'uri de l'atelier dans Scenari).
long	getTimestamp() Timestamp de dernière modification Utilisé par Scenari pour savoir si le contenu a été modifié.
String	getTitle() Titre de ce noeud (aucune contrainte sur les caractères utilisés).
String	getVersionComment() Retourne le commentaire de cette version.
String	getVersionLabel() Retourne le label de cette version.
ScenariNode.VersionOrigin	getVersionOrigin() Origine / raison pour laquelle cette version a été créée.
long	getVersionTimestamp() Retourne la date de création de cette version.
boolean	isVersion() Ce noeud est-il une version ?
boolean	isVisible() Indique si le noeud a été supprimé La suppression est toujours uniquement "logique" afin de présever le couple id / path.
void	remove() Suppression de ce noeud.
void	restoreNode() Restaure un noeud supprimé.
void	save() Enristrement des modifications apportées à ce noeud.
void	setLinks(List<ScenariLink> links) Affecte une nouvelle liste de liens.
long	setTimestamp(long pTimestamp) Affectation du timestamp de ce noeud.
void	setTitle(String title) Affectation du titre.

Method Detail

getId

String getId()

Id nuxeo de ce noeud.

getPath

String getPath()

Chemin de ce noeud (différent de l'uri de l'atelier dans Scenari).

getName

String getName()

Fragment terminal du chemin correspondant au nom du fichier ou du dossier.

getTitle

String getTitle()
                throws Exception

Titre de ce noeud (aucune contrainte sur les caractères utilisés).

Throws:

Exception

isVisible

boolean isVisible()
                  throws Exception

Indique si le noeud a été supprimé

La suppression est toujours uniquement "logique" afin de présever le couple id / path.

Throws:

Exception

getTimestamp

long getTimestamp()
                  throws Exception

Timestamp de dernière modification

Utilisé par Scenari pour savoir si le contenu a été modifié.

Throws:

Exception

getModificationUser

String getModificationUser()
                           throws Exception

Compte de l'utilisateur ayant réalisé la dernière modification.

Throws:

Exception

getDocumentModel

org.nuxeo.ecm.core.api.DocumentModel getDocumentModel()

Objet de l'API Nuxeo représentant ce noeud.

setTitle

void setTitle(String title)
              throws Exception

Affectation du titre.

Throws:

Exception

setTimestamp

long setTimestamp(long pTimestamp)
                  throws Exception

Affectation du timestamp de ce noeud.

Appelé par la couche Scenari lorsqu'elle est informé d'une modification de ce noeud (dans le listeners d'events). L'implémentation doit vérifier que le timestamp soit toujours différent de la précédente valeur (ajouter 1 si nécessaire).

Throws:

Exception

save

void save()
          throws Exception

Enristrement des modifications apportées à ce noeud.

Throws:

Exception

remove

void remove()
            throws Exception

Suppression de ce noeud.

Throws:

Exception

isVersion

boolean isVersion()
                  throws Exception

Ce noeud est-il une version ?

Throws:

Exception

getLiveId

String getLiveId()
                 throws Exception

Id du "live" document auquel appartient cette version.

Si ce noeud est un live document, la méthode retourne son propre id.

Throws:

Exception

getLinks

List<ScenariLink> getLinks()
                           throws Exception

Retourne les liens vers d'autres items de cet item.

S'il s'agit d'une version de type master ou slave, les liens retournés sont ceux du réseau versionné auquel appartient le noeud.

Throws:

Exception

setLinks

void setLinks(List<ScenariLink> links)
              throws Exception

Affecte une nouvelle liste de liens.

Throws:

Exception

getVersionLabel

String getVersionLabel()
                       throws Exception

Retourne le label de cette version.

Throws:

Exception

getVersionComment

String getVersionComment()
                         throws Exception

Retourne le commentaire de cette version.

Throws:

Exception

getVersionTimestamp

long getVersionTimestamp()
                         throws Exception

Retourne la date de création de cette version.

Throws:

Exception

getVersionOrigin

ScenariNode.VersionOrigin getVersionOrigin()
                                           throws Exception

Origine / raison pour laquelle cette version a été créée.

Throws:

Exception

getNetVersions

List<ScenariItem> getNetVersions()
                                 throws Exception

Retourne la liste des versions dont cet item a été la racine.

Throws:

Exception

createNetVersion

void createNetVersion(String pComment,
                      Map<String,Object> pOptions)
                      throws Exception

Créé une nouvelle version à partir cet item racine.

Une origine est affecté à chaque noeud du réseau versionné : VersionOrigin.master pour l'item racine, VersionOrigin.slave pour les autres.

Parameters:

pComment - Commentaire libre de la version.

pOptions - Options sur la création de la version, tel qu'un label personnalisé

Throws:

Exception

restoreNode

void restoreNode()
                 throws Exception

Restaure un noeud supprimé.

Throws:

Exception