001/*
002 * (C) Copyright 2012 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 *     Thierry Delprat
018 */
019package org.nuxeo.ecm.platform.publisher.helper;
020
021import org.nuxeo.ecm.core.api.DocumentModel;
022import org.nuxeo.ecm.core.api.DocumentModelList;
023
024public interface RootSectionFinder {
025
026    void reset();
027
028    /**
029     * Returns the head (root) sections that are bound to a given Workspace.
030     * <p>
031     * If no specific binding is defined at the workspace level, an empty list is returned.
032     *
033     * @param currentDoc the target Workspace
034     * @param addDefaultSectionRoots flag to indicate is default roots should be added
035     * @return
036     */
037    DocumentModelList getSectionRootsForWorkspace(DocumentModel currentDoc, boolean addDefaultSectionRoots);
038
039    /**
040     * Returns the head (root) sections that are bound to a given Workspace.
041     * <p>
042     * If no specific binding is defined at the workspace level, an empty list is returned.
043     *
044     * @param currentDoc the target Workspace
045     * @return
046     */
047    DocumentModelList getSectionRootsForWorkspace(DocumentModel currentDoc);
048
049    DocumentModelList getAccessibleSectionRoots(DocumentModel currentDoc);
050
051    DocumentModelList getDefaultSectionRoots(boolean onlyHeads, boolean addDefaultSectionRoots);
052
053    DocumentModelList getDefaultSectionRoots(boolean onlyHeads);
054
055}