001/*
002 * (C) Copyright 2015 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 *
016 * Contributors:
017 */
018package org.nuxeo.ecm.platform.rendition.service;
019
020import org.nuxeo.ecm.core.api.Blob;
021import org.nuxeo.ecm.core.api.DocumentModel;
022import org.nuxeo.ecm.platform.rendition.impl.StoredRendition;
023
024/**
025 * Manages {@link StoredRendition}s on behalf of the {@link RenditionService}.
026 *
027 * @since 8.1
028 */
029public interface StoredRenditionManager {
030
031    /**
032     * Creates a {@link StoredRendition} for the live document or the version document if provided.
033     *
034     * @param liveDocument the live document
035     * @param versionDocument the version document
036     * @param renditionBlob the rendition blob
037     * @param renditionDefinition the rendition definition
038     * @return the created stored rendition
039     */
040    StoredRendition createStoredRendition(DocumentModel liveDocument, DocumentModel versionDocument, Blob renditionBlob,
041            RenditionDefinition renditionDefinition);
042
043    /**
044     * Finds the {@link StoredRendition} associated with a {@link DocumentModel}.
045     *
046     * @param sourceDocument the source document
047     * @param renditionDefinition the rendition definition
048     * @return the found stored rendition, or {@code null} if not found
049     */
050    StoredRendition findStoredRendition(DocumentModel sourceDocument, RenditionDefinition renditionDefinition);
051
052}