org.nuxeo.ecm.platform.userworkspace.api
Interface UserWorkspaceManagerActions

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

UserWorkspaceManagerActionsBean

public interface UserWorkspaceManagerActions
extends java.io.Serializable

User workspace manager actions business interface.

Author:

btatar

Method Summary

void	destroy()
DocumentModel	getCurrentUserPersonalWorkspace() Gets the current user personal workspace.
void	initialize()
boolean	isShowingPersonalWorkspace() Checks wether a personal document is selected.
java.lang.String	navigateToCurrentUserPersonalWorkspace() Navigates to the current user personal workspace.
java.lang.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

java.lang.String navigateToCurrentUserPersonalWorkspace()
                                                        throws ClientException

Navigates to the current user personal workspace.

Returns:

Throws:

ClientException

navigateToOverallWorkspace

java.lang.String navigateToOverallWorkspace()
                                            throws ClientException

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

Returns:

Throws:

ClientException

isShowingPersonalWorkspace

boolean isShowingPersonalWorkspace()

Checks wether a personal document is selected.

Returns:

true if it is a personal document

false otherwise

destroy

void destroy()

initialize

void initialize()