src/java/org/apache/lenya/cms/repo/Area.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;

/**
 * An area.
 */
public interface Area {

    /**
     * @return The content of this area.
     * @throws RepositoryException if an error occurs.
     */
    Content getContent() throws RepositoryException;
    
    /**
     * @return The site of this area.
     * @throws RepositoryException if an error occurs.
     */
    Site getSite() throws RepositoryException;
    
    /**
     * Removes all content and site nodes from this area.
     * @throws RepositoryException if an error occurs.
     */
    void clear() throws RepositoryException;
    
    /**
     * @return The ID of the area.
     * @throws RepositoryException if an error occurs.
     */
    String getAreaID() throws RepositoryException;
    
    /**
     * @return The publication the area belongs to.
     * @throws RepositoryException if an error occurs.
     */
    Publication getPublication() throws RepositoryException;
    
}