001/*
002 * (C) Copyright 2006-2007 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     btatar
016 *
017 * $Id$
018 */
019
020package org.nuxeo.ecm.platform.userworkspace.api;
021
022import java.io.Serializable;
023import org.nuxeo.ecm.core.api.DocumentModel;
024
025/**
026 * User workspace manager actions business interface.
027 *
028 * @author btatar
029 */
030public interface UserWorkspaceManagerActions extends Serializable {
031
032    /**
033     * Gets the current user personal workspace.
034     *
035     * @return the personal workspace
036     */
037    DocumentModel getCurrentUserPersonalWorkspace();
038
039    /**
040     * Navigates to the current user personal workspace.
041     */
042    String navigateToCurrentUserPersonalWorkspace();
043
044    /**
045     * Navigates to the overall workspace. Introduced for INA-221 (Rux).
046     */
047    String navigateToOverallWorkspace();
048
049    /**
050     * Checks wether a personal document is selected.
051     *
052     * @return true if it is a personal document, false otherwise
053     */
054    boolean isShowingPersonalWorkspace();
055
056}