001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.workflow;
029
030import org.opencms.ade.publish.CmsPublishRelationFinder.ResourceMap;
031import org.opencms.ade.publish.shared.CmsPublishOptions;
032import org.opencms.ade.publish.shared.CmsPublishResource;
033import org.opencms.main.CmsException;
034
035import java.util.List;
036
037/**
038 * 'Formats' a ResourceMap containing resources for publishing by creating a list of CmsPublishResource
039 * beans with the appropriate status informations to display.
040 */
041public interface I_CmsPublishResourceFormatter {
042
043    /**
044     * Gets the publish resource beans created by this formatter.<p>
045     *
046     * @return the publish resource beans
047     * @throws CmsException if something goes wrong
048     */
049    List<CmsPublishResource> getPublishResources() throws CmsException;
050
051    /**
052     * Initializes the formatter.<p>
053     *
054     * @param options the publish options
055     * @param resources the publish resources
056     *
057     * @throws CmsException in case something goes wrong
058     */
059    void initialize(CmsPublishOptions options, ResourceMap resources) throws CmsException;
060}