001/*
002 * (C) Copyright 2012 Nuxeo SA (http://nuxeo.com/) and others.
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 * Contributors:
016 * Nuxeo - initial API and implementation
017 */
018
019package org.nuxeo.ecm.platform.rendition;
020
021import java.util.List;
022
023import org.nuxeo.ecm.platform.rendition.service.RenditionDefinition;
024
025/**
026 * Interface on an Object that can be used to produce {@link Rendition}
027 *
028 * @author <a href="mailto:tdelprat@nuxeo.com">Tiry</a>
029 */
030public interface Renderable {
031
032    /**
033     * Returns {@link RenditionDefinition} that are available on the underlying object
034     *
035     * @return
036     */
037    List<RenditionDefinition> getAvailableRenditionDefinitions();
038
039    /**
040     * Retrieve the {@link Rendition} by it's name
041     *
042     * @param name
043     * @return
044     */
045    Rendition getRenditionByName(String name);
046
047    /**
048     * Retrieve the {@link Rendition} by it's king (first match rendition is returned)
049     *
050     * @param name
051     * @return
052     */
053    Rendition getRenditionByKind(String name);
054
055}