org.nuxeo.ecm.platform.userworkspace.api

Interface UserWorkspaceManagerActions

All Superinterfaces:

Serializable

All Known Implementing Classes:

UserWorkspaceManagerActionsBean

public interface UserWorkspaceManagerActions
extends Serializable

User workspace manager actions business interface.

Author:

btatar

Method Summary

Methods

Modifier and Type	Method and Description
DocumentModel	getCurrentUserPersonalWorkspace() Gets the current user personal workspace.
boolean	isShowingPersonalWorkspace() Checks wether a personal document is selected.
String	navigateToCurrentUserPersonalWorkspace() Navigates to the current user personal workspace.
String	navigateToOverallWorkspace() Navigates to the overall workspace.

Method Detail

getCurrentUserPersonalWorkspace

DocumentModel getCurrentUserPersonalWorkspace()
                                              throws ClientException

Gets the current user personal workspace.

Returns:

the personal workspace

Throws:

ClientException

navigateToCurrentUserPersonalWorkspace

String navigateToCurrentUserPersonalWorkspace()
                                              throws ClientException

Navigates to the current user personal workspace.

Throws:

ClientException

navigateToOverallWorkspace

String navigateToOverallWorkspace()
                                  throws ClientException

Navigates to the overall workspace. Introduced for INA-221 (Rux).

Throws:

ClientException

isShowingPersonalWorkspace

boolean isShowingPersonalWorkspace()

Checks wether a personal document is selected.

Returns:

true if it is a personal document, false otherwise