org.nuxeo.ecm.platform.userworkspace.api

Interface UserWorkspaceService

All Superinterfaces:

Serializable

All Known Implementing Classes:

CompatUserWorkspaceServiceImpl, DefaultUserWorkspaceServiceImpl

public interface UserWorkspaceService
extends Serializable

User workspace service class that is used to get the document model for the personal workspace of the current user.

Author:

btatar

Method Summary

Methods

Modifier and Type	Method and Description
DocumentModel	getCurrentUserPersonalWorkspace(CoreSession userCoreSession, DocumentModel context)
DocumentModel	getCurrentUserPersonalWorkspace(String userName, DocumentModel currentDocument) Gets the current user personal workspace from a lower level.
DocumentModel	getUserPersonalWorkspace(String userName, DocumentModel context) Gets a detached user workspace of a specified user.

Method Detail

getCurrentUserPersonalWorkspace

DocumentModel getCurrentUserPersonalWorkspace(String userName,
                                            DocumentModel currentDocument)
                                              throws ClientException

Gets the current user personal workspace from a lower level.

If this personal workspace does not exist then a new one will be created for the user who is represented by first argument.

Parameters:

userName - the current user

currentDocument - the current document on which the user was on

Returns:

the DocumentModel for the personal workspace of the current user

Throws:

ClientException

getCurrentUserPersonalWorkspace

DocumentModel getCurrentUserPersonalWorkspace(CoreSession userCoreSession,
                                            DocumentModel context)
                                              throws ClientException

Throws:

ClientException

getUserPersonalWorkspace

DocumentModel getUserPersonalWorkspace(String userName,
                                     DocumentModel context)
                                       throws ClientException

Gets a detached user workspace of a specified user.

Parameters:

userName - is the username of the wanted user's workspace owner

context - is a document to determine the domain

Returns:

the DocumentModel for the personal workspace

Throws:

ClientException

Since:

5.5