001/*
002 *  Copyright 2010 Anyware Services
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 */
016package org.ametys.cms.source;
017
018import java.io.IOException;
019
020import org.apache.excalibur.source.Source;
021
022/**
023 * Component responsible to lookup a {@link Source} for a content view
024 */
025public interface ContentView
026{
027    /** Avalon Role */
028    public static final String ROLE = ContentView.class.getName();
029    
030    /**
031     * Get the file source for rendering a content
032     * @param location the requested location
033     * @param contentType the type of the current Content
034     * @param view the content view
035     * @param format the format of the output (html, pdf, ...)
036     * @param pluginName the current plugin name
037     * @return the file source
038     * @throws IOException if the Source cannot be resolved
039     */
040    public Source getSource(String location, String contentType, String view, String format, String pluginName) throws IOException;
041}