Interface EditionService

All Known Implementing Classes:
EditionServiceImpl

public interface EditionService
The API to manage editions of a mlContainer. An edition is a version of a mlContainer
Since:
2.1
Author:
Yannick Pignot
  • Method Details

    • createEdition

      @Auditable(parameters={"translationNodeRef","versionProperties"}) NodeRef createEdition(NodeRef translationNodeRef, Map<String,Serializable> versionProperties)
      Create a new edition of an existing cm:mlContainer using any one of the associated cm:mlDocument transalations. If startingTranslationNodeRef is multilingual, it will be copied. The copy will become the pivot translation of the new Edition of the cm:mlContainer. The reference of the copy will be returned.
      Parameters:
      translationNodeRef - The specific cm:mlDocument to use as the starting point of the new edition. All other translations will be removed.
    • getEditions

      @Auditable(parameters="mlContainer") VersionHistory getEditions(NodeRef mlContainer)
      Get editions of an existing cm:mlContainer.
      Parameters:
      mlContainer - An existing cm:mlContainer
      Returns:
      The Version History of the mlContainer
    • getVersionedTranslations

      @Auditable(parameters="mlContainerEdition") List<VersionHistory> getVersionedTranslations(Version mlContainerEdition)
      Get the different cm:mlDocument transalation version histories of a specific edition of a cm:mlContainer
      Parameters:
      mlContainerEdition - An existing version of a mlContainer
      Returns:
      The list of cm:mlDocument transalation versions of the edition
    • getVersionedMetadatas

      @Auditable(parameters="version") Map<QName,Serializable> getVersionedMetadatas(Version version)
      Get the the versioned metadata of a specific cm:mlDocument transalation version or a specific cm:mlContainer version
      Parameters:
      version - An existing version of a cm:mlDocument translation version or an existing version of a cm:mlContainer version.
      Returns:
      The versioned metadata