org.nuxeo.scenari.service
Interface ScenariStorageService

public interface ScenariStorageService

Service de stockage des noeuds Scenari dans Nuxeo

Method Summary

void	closeRepositorySession(org.nuxeo.ecm.core.api.CoreSession session) Méthode utilitaire pour fermer une CoreSession
ScenariWorkspace	createWorkspace(org.nuxeo.ecm.core.api.CoreSession session, String name) Crée un ScenariWorkspace à l'emplacement par défaut
ScenariWorkspace	createWorkspace(org.nuxeo.ecm.core.api.CoreSession session, String parentPath, String name) Crée un ScenariWorkspace à l'emplacement parentPath
String	getIdForPath(org.nuxeo.ecm.core.api.CoreSession session, String path, boolean pCreateIfNone) Retourne l'id d'un noeud par son chemin (même si le document est supprimé).
ScenariNode	getNode(org.nuxeo.ecm.core.api.DocumentModel pDoc) Retourne un ScenariNode à partir d'un document de l'Api Nuxeo.
ScenariNode	getNodeById(org.nuxeo.ecm.core.api.CoreSession session, String id, Boolean pIfTrashed) Retourne un ScenariNode par son id.
ScenariNode	getNodeByPath(org.nuxeo.ecm.core.api.CoreSession session, String path) Retourne un ScenariNode par son chemin
ScenariWorkspace	getNodeOwnerWorkspace(org.nuxeo.ecm.core.api.CoreSession pSession, ScenariNode pNode) Méthode utilitaire pour obtenir le ScenariWorkspace d'un ScenariNode
String	getPathForId(org.nuxeo.ecm.core.api.CoreSession session, String id) Retourne le chemin d'un noeud par son id (même si le document est supprimé).
List<ScenariNode>	getPointerNodes(org.nuxeo.ecm.core.api.CoreSession pSession, String pId) Retourne la liste des ScenariNode pointant le noeud d'id pId
ScenariNode	getVersionNodeById(org.nuxeo.ecm.core.api.CoreSession session, String type, String versionId) Retourne un ScenariNode versionné par son versionId.
List<ScenariWorkspace>	listWorkspaces(org.nuxeo.ecm.core.api.CoreSession session) Liste les ScenariWorkspace du système
ScenariNode	move(org.nuxeo.ecm.core.api.CoreSession pSession, ScenariNode pFromNode, ScenariSpace pTargetParent, String pTargetName) Déplace un ScenariNode vers pTargetParent
org.nuxeo.ecm.core.api.CoreSession	openRepositorySession(String repositoryName) Méthode utilitaire pour ouvrir une CoreSession sur un dépot donné
void	registerCallback(ScenariCallBack cb) Enregistre un ScenariCallback pour notification des évènements sur le workspace

Method Detail

listWorkspaces

List<ScenariWorkspace> listWorkspaces(org.nuxeo.ecm.core.api.CoreSession session)
                                      throws Exception

Liste les ScenariWorkspace du système

Throws:

Exception

getNodeById

ScenariNode getNodeById(org.nuxeo.ecm.core.api.CoreSession session,
                        String id,
                        Boolean pIfTrashed)
                        throws Exception

Retourne un ScenariNode par son id.

Parameters:

pIfTrashed - Filtre sur l'état du noeud

• true : Retourne le noeud si il est en état supprimé (ie en corbeille).
• false : Retourne le noeud si il est visible.
• null : Retourne le noeud quelque soit son état (visible, en corbeille, "hidden" pour créer un couple uri/id).

Throws:

Exception

getVersionNodeById

ScenariNode getVersionNodeById(org.nuxeo.ecm.core.api.CoreSession session,
                               String type,
                               String versionId)
                               throws Exception

Retourne un ScenariNode versionné par son versionId. TODO : enlever de l'interface ?

Throws:

Exception

getNode

ScenariNode getNode(org.nuxeo.ecm.core.api.DocumentModel pDoc)
                    throws Exception

Retourne un ScenariNode à partir d'un document de l'Api Nuxeo.

Throws:

Exception

getPathForId

String getPathForId(org.nuxeo.ecm.core.api.CoreSession session,
                    String id)
                    throws Exception

Retourne le chemin d'un noeud par son id (même si le document est supprimé).

Throws:

Exception

getIdForPath

String getIdForPath(org.nuxeo.ecm.core.api.CoreSession session,
                    String path,
                    boolean pCreateIfNone)
                    throws Exception

Retourne l'id d'un noeud par son chemin (même si le document est supprimé).

Throws:

Exception

getNodeByPath

ScenariNode getNodeByPath(org.nuxeo.ecm.core.api.CoreSession session,
                          String path)
                          throws Exception

Retourne un ScenariNode par son chemin

Throws:

Exception

createWorkspace

ScenariWorkspace createWorkspace(org.nuxeo.ecm.core.api.CoreSession session,
                                 String name)
                                 throws Exception

Crée un ScenariWorkspace à l'emplacement par défaut

Throws:

Exception

createWorkspace

ScenariWorkspace createWorkspace(org.nuxeo.ecm.core.api.CoreSession session,
                                 String parentPath,
                                 String name)
                                 throws Exception

Crée un ScenariWorkspace à l'emplacement parentPath

Throws:

Exception

registerCallback

void registerCallback(ScenariCallBack cb)

Enregistre un ScenariCallback pour notification des évènements sur le workspace

openRepositorySession

org.nuxeo.ecm.core.api.CoreSession openRepositorySession(String repositoryName)
                                                         throws Exception

Méthode utilitaire pour ouvrir une CoreSession sur un dépot donné

Parameters:

repositoryName - Nom du dépot ou null pour le dépot par défaut.

Throws:

Exception

closeRepositorySession

void closeRepositorySession(org.nuxeo.ecm.core.api.CoreSession session)
                            throws Exception

Méthode utilitaire pour fermer une CoreSession

Throws:

Exception

getNodeOwnerWorkspace

ScenariWorkspace getNodeOwnerWorkspace(org.nuxeo.ecm.core.api.CoreSession pSession,
                                       ScenariNode pNode)
                                       throws Exception

Méthode utilitaire pour obtenir le ScenariWorkspace d'un ScenariNode

Throws:

Exception

move

ScenariNode move(org.nuxeo.ecm.core.api.CoreSession pSession,
                 ScenariNode pFromNode,
                 ScenariSpace pTargetParent,
                 String pTargetName)
                 throws Exception

Déplace un ScenariNode vers pTargetParent

Throws:

Exception

getPointerNodes

List<ScenariNode> getPointerNodes(org.nuxeo.ecm.core.api.CoreSession pSession,
                                  String pId)
                                  throws Exception

Retourne la liste des ScenariNode pointant le noeud d'id pId

Throws:

Exception