src/java/org/apache/lenya/cms/repo/Site.java

/*
 * Copyright  1999-2004 The Apache Software Foundation
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */
package org.apache.lenya.cms.repo;

/**
 * The site structure of an area.
 */
public interface Site {

    /**
     * @return The top level nodes in this area.
     * @throws RepositoryException if an error occurs.
     */
    SiteNode[] getChildren() throws RepositoryException;

    /**
     * @return The nodes of this site in preorder.
     * @throws RepositoryException if an error occurs.
     */
    SiteNode[] preOrder() throws RepositoryException;

    /**
     * @param name The name.
     * @param document The document which the site node refers to.
     * @return a site node.
     * @throws RepositoryException if a node with this path already exists.
     */
    SiteNode addChild(String name, Document document) throws RepositoryException;

    /**
     * @param name The name.
     * @return a site node.
     * @throws RepositoryException if the node does not exist.
     */
    SiteNode getChild(String name) throws RepositoryException;

    /**
     * @param path The path of the node.
     * @return A site node.
     * @throws RepositoryException if the node does not exist.
     */
    SiteNode getNode(String path) throws RepositoryException;

    /**
     * @return The area this site belongs to.
     * @throws RepositoryException if an error occurs.
     */
    Area getArea() throws RepositoryException;

    /**
     * Moves a subtree to another location.
     * @param srcAbsPath The path of the node to move.
     * @param destAbsPath The destination path.
     * @throws RepositoryException if the destination node already exists or the destination parent
     *             does not exist.
     */
    void move(String srcAbsPath, String destAbsPath) throws RepositoryException;
    
    /**
     * @param document A document.
     * @return The nodes referencing the document.
     * @throws RepositoryException if an error occurs.
     */
    SiteNode[] getReferences(Document document) throws RepositoryException;
    
    /**
     * @param document A document.
     * @return The first node referencing the document or <code>null</code> if the document is not referenced.
     * @throws RepositoryException if an error occurs.
     */
    SiteNode getFirstReference(Document document) throws RepositoryException;

}