Files
alfresco-community-repo/source/java/org/alfresco/service/cmr/ml/EditionService.java
Raluca Munteanu 8674e2bfc8 Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)
125603 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
      125484 slanglois: MNT-16155 Update source headers - remove old Copyrights from Java and JSP dource files


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@125781 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2016-04-26 12:48:49 +00:00

65 lines
2.7 KiB
Java

package org.alfresco.service.cmr.ml;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
import org.alfresco.service.Auditable;
import org.alfresco.service.PublicService;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.version.Version;
import org.alfresco.service.cmr.version.VersionHistory;
import org.alfresco.service.namespace.QName;
/**
* The API to manage editions of a mlContainer. An edition is a version of a <b>mlContainer</b>
*
* @since 2.1
* @author Yannick Pignot
*/
public interface EditionService
{
/**
* Create a new edition of an existing <b>cm:mlContainer</b> using any one of the
* associated <b>cm:mlDocument</b> transalations.
*
* If startingTranslationNodeRef is multilingual, it will be copied. The copy will become the pivot translation
* of the new Edition of the <b>cm:mlContainer</b>. The reference of the copy will be returned.
*
* @param translationNodeRef The specific <b>cm:mlDocument</b> to use as the starting point
* of the new edition. All other translations will be removed.
*/
@Auditable(parameters = {"translationNodeRef", "versionProperties"})
NodeRef createEdition(NodeRef translationNodeRef, Map<String, Serializable> versionProperties);
/**
* Get editions of an existing <b>cm:mlContainer</b>.
*
* @param mlContainer An existing <b>cm:mlContainer</b>
* @return The Version History of the mlContainer
*/
@Auditable(parameters = {"mlContainer"})
VersionHistory getEditions(NodeRef mlContainer);
/**
* Get the different <b>cm:mlDocument</b> transalation version histories of a specific edition of a <b>cm:mlContainer</b>
*
* @param mlContainerEdition An existing version of a mlContainer
* @return The list of <b>cm:mlDocument</b> transalation versions of the edition
*/
@Auditable(parameters = {"mlContainerEdition"})
List<VersionHistory> getVersionedTranslations(Version mlContainerEdition);
/**
* Get the the versioned metadata of a specific <b>cm:mlDocument</b> transalation version or a specific
* <b>cm:mlContainer</b> version
*
* @param version An existing version of a <b>cm:mlDocument</b> translation version or
* an existing version of a <b>cm:mlContainer</b> version.
* @return The versioned metadata
*/
@Auditable(parameters = {"version"})
Map<QName, Serializable> getVersionedMetadatas(Version version);
}