mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-10-22 15:12:38 +00:00
6afb44e712
125606 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
125515 slanglois: MNT-16155 Update source headers - add new Copyrights for Java and JSP source files + automatic check in the build
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@125788 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
94 lines
3.6 KiB
Java
94 lines
3.6 KiB
Java
/*
|
|
* #%L
|
|
* Alfresco Repository
|
|
* %%
|
|
* Copyright (C) 2005 - 2016 Alfresco Software Limited
|
|
* %%
|
|
* This file is part of the Alfresco software.
|
|
* If the software was purchased under a paid Alfresco license, the terms of
|
|
* the paid license agreement will prevail. Otherwise, the software is
|
|
* provided under the following open source license terms:
|
|
*
|
|
* Alfresco is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
* #L%
|
|
*/
|
|
|
|
package org.alfresco.repo.rendition;
|
|
|
|
import java.util.List;
|
|
|
|
import org.alfresco.service.cmr.rendition.RenditionDefinition;
|
|
import org.alfresco.service.namespace.QName;
|
|
|
|
/**
|
|
* This class provides the implementation of {@link RenditionDefinition} persistence.
|
|
* <p/>
|
|
* Note that rendition definitions are saved underneath the Data Dictionary and therefore any code
|
|
* which loads or saves rendition definitions must have the appropriate authorisation.
|
|
*
|
|
* @author Nick Smith
|
|
* @author Neil McErlean
|
|
* @since 3.3
|
|
*/
|
|
public interface RenditionDefinitionPersister
|
|
{
|
|
/**
|
|
* This method serializes the {@link RenditionDefinition} and stores it in
|
|
* the repository. {@link RenditionDefinition}s saved in this way may be
|
|
* retrieved using the <code>load()</code> method.
|
|
*
|
|
* @param renditionDefinition The {@link RenditionDefinition} to be
|
|
* persisted.
|
|
*/
|
|
void saveRenditionDefinition(RenditionDefinition renditionDefinition);
|
|
|
|
/**
|
|
* This method retrieves a {@link RenditionDefinition} that has been stored
|
|
* in the repository using the <code>save()</code> method. If no
|
|
* {@link RenditionDefinition} exists in the repository with the specified
|
|
* rendition name then this method returns null.
|
|
*
|
|
* @param renditionName The unique identifier used to specify the
|
|
* {@link RenditionDefinition} to retrieve.
|
|
* @return The specified {@link RenditionDefinition} or null.
|
|
*/
|
|
RenditionDefinition loadRenditionDefinition(QName renditionName);
|
|
|
|
/**
|
|
* This method retrieves the {@link RenditionDefinition}s that have been
|
|
* stored in the repository using the <code>save()</code> method.
|
|
* <P/>
|
|
* If there are no such {@link RenditionDefinition}s, an empty list is
|
|
* returned.
|
|
*
|
|
* @return The {@link RenditionDefinition}s.
|
|
*/
|
|
List<RenditionDefinition> loadRenditionDefinitions();
|
|
|
|
/**
|
|
* This method retrieves the stored {@link RenditionDefinition}s that have
|
|
* been registered for the specified rendering engine name.
|
|
* <P/>
|
|
* If there are no such rendering {@link RenditionDefinition}s, an empty
|
|
* list is returned.
|
|
*
|
|
* @param renderingEngineName the name of a rendering engine. This is
|
|
* usually the spring bean name.
|
|
* @return The {@link RenditionDefinition}s.
|
|
* @throws NullPointerException if the renderingEngineName is null.
|
|
* @see #saveRenditionDefinition(RenditionDefinition)
|
|
*/
|
|
List<RenditionDefinition> loadRenditionDefinitions(String renderingEngineName);
|
|
}
|