001/*
002 * (C) Copyright 2006-2007 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     btatar
018 *
019 * $Id$
020 */
021
022package org.nuxeo.ecm.platform.userworkspace.api;
023
024import java.io.Serializable;
025import org.nuxeo.ecm.core.api.DocumentModel;
026
027/**
028 * User workspace manager actions business interface.
029 *
030 * @author btatar
031 */
032public interface UserWorkspaceManagerActions extends Serializable {
033
034    /**
035     * Gets the current user personal workspace.
036     *
037     * @return the personal workspace
038     */
039    DocumentModel getCurrentUserPersonalWorkspace();
040
041    /**
042     * Navigates to the current user personal workspace.
043     */
044    String navigateToCurrentUserPersonalWorkspace();
045
046    /**
047     * Navigates to the overall workspace. Introduced for INA-221 (Rux).
048     */
049    String navigateToOverallWorkspace();
050
051    /**
052     * Checks wether a personal document is selected.
053     *
054     * @return true if it is a personal document, false otherwise
055     */
056    boolean isShowingPersonalWorkspace();
057
058}