org.apache.lenya.core.publication.api/src/main/java/org/apache/lenya/cms/publication/PublicationManager.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You 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.publication;

/**
 * Publication manager.
 */
public interface PublicationManager {

    /**
     * The service's role.
     */
    String ROLE = PublicationManager.class.getName();
    
    /**
     * @param factory The factory.
     * @return All publications.
     */
    Publication[] getPublications(DocumentFactory factory);
    
    /**
     * @param factory The factory.
     * @param id The publication ID.
     * @return A publication.
     * @throws PublicationException if the publication does not exist.
     */
    Publication getPublication(DocumentFactory factory, String id) throws PublicationException;
    
    /**
     * @return The IDs of all available publications.
     */
    String[] getPublicationIds();
    
    /**
     * Adds a publication.
     * @param id The publication ID.
     * @throws PublicationException if the publication already exists.
     */
    void addPublication(String id) throws PublicationException;
    
}