001/*
002 * (C) Copyright 2012 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 * Contributors:
014 * Nuxeo - initial API and implementation
015 */
016
017package org.nuxeo.ecm.platform.rendition;
018
019import java.util.List;
020
021import org.nuxeo.ecm.platform.rendition.service.RenditionDefinition;
022
023/**
024 * Interface on an Object that can be used to produce {@link Rendition}
025 *
026 * @author <a href="mailto:tdelprat@nuxeo.com">Tiry</a>
027 */
028public interface Renderable {
029
030    /**
031     * Returns {@link RenditionDefinition} that are available on the underlying object
032     *
033     * @return
034     */
035    List<RenditionDefinition> getAvailableRenditionDefinitions();
036
037    /**
038     * Retrieve the {@link Rendition} by it's name
039     *
040     * @param name
041     * @return
042     */
043    Rendition getRenditionByName(String name);
044
045    /**
046     * Retrieve the {@link Rendition} by it's king (first match rendition is returned)
047     *
048     * @param name
049     * @return
050     */
051    Rendition getRenditionByKind(String name);
052
053}