Interface EntityVersionService

All Known Implementing Classes:
EntityVersionServiceImpl

public interface EntityVersionService
The Interface EntityVersionService.
Version:
$Id: $Id
Author:
querephi
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    afterCancelCheckOut(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)
    afterCancelCheckOut.
    List<org.alfresco.service.cmr.repository.NodeRef>
    buildVersionHistory(org.alfresco.service.cmr.repository.NodeRef versionHistoryRef, org.alfresco.service.cmr.repository.NodeRef nodeRef)
    buildVersionHistory.
    void
    cancelCheckOut(org.alfresco.service.cmr.repository.NodeRef origNodeRef, org.alfresco.service.cmr.repository.NodeRef workingCopyNodeRef)
    cancelCheckOut.
    org.alfresco.service.cmr.repository.NodeRef
    convertVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef)
    convertVersion.
    org.alfresco.service.cmr.repository.NodeRef
    createBranch(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, org.alfresco.service.cmr.repository.NodeRef parentRef)
    createBranch.
    void
    createInitialVersion(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)
    createInitialVersion.
    void
    createInitialVersion(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, Date effectiveDate)
    createInitialVersion.
    void
    createInitialVersionWithProps(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, Map<org.alfresco.service.namespace.QName,Serializable> before)
    createInitialVersionWithProps.
    org.alfresco.service.cmr.repository.NodeRef
    createVersion(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, Map<String,Serializable> versionProperties)
    createVersion.
    org.alfresco.service.cmr.repository.NodeRef
    createVersion(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, Map<String,Serializable> versionProperties, Date effectiveDate)
    createVersion.
    void
    deleteEntityVersion(org.alfresco.service.cmr.version.Version version)
    deleteEntityVersion.
    void
    deleteVersionHistory(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)
    deleteVersionHistory.
    org.alfresco.service.cmr.repository.NodeRef
    extractVersion(org.alfresco.service.cmr.repository.NodeRef entity1)
    extractVersion.
    Set<org.alfresco.service.cmr.repository.NodeRef>
    findOldVersionWUsed(org.alfresco.service.cmr.repository.NodeRef sourceEntity)
    findOldVersionWUsed.
    Set<org.alfresco.service.cmr.repository.NodeRef>
    findOldVersionWUsed(org.alfresco.service.cmr.repository.NodeRef originalEntity, Set<org.alfresco.service.cmr.repository.NodeRef> visited, List<org.alfresco.service.cmr.repository.NodeRef> ignoredItems, int maxProcessedNodes, org.apache.commons.lang3.mutable.MutableInt currentCount, String path)
    findOldVersionWUsed.
    getAllVersionAndBranches(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)
    getAllVersionAndBranches.
    List<org.alfresco.service.cmr.repository.NodeRef>
    getAllVersionBranches(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)
    getAllVersionBranches.
    getAllVersions(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)
    getAllVersions.
    org.alfresco.service.cmr.repository.NodeRef
    getEntitiesHistoryFolder.
    org.alfresco.service.cmr.repository.NodeRef
    getEntityVersion(org.alfresco.service.cmr.version.Version version)
    getEntityVersion.
    org.alfresco.service.cmr.repository.NodeRef
    getVersionHistoryNodeRef(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, boolean shouldCreate)
    getVersionHistoryNodeRef.
    void
    impactWUsed(org.alfresco.service.cmr.repository.NodeRef newEntityNodeRef, org.alfresco.service.cmr.version.VersionType versionType, String description, Date effectiveDate)
    impactWUsed.
    org.alfresco.service.cmr.repository.NodeRef
    mergeBranch(org.alfresco.service.cmr.repository.NodeRef branchNodeRef, Date newEffectivity)
    mergeBranch.
    org.alfresco.service.cmr.repository.NodeRef
    mergeBranch(org.alfresco.service.cmr.repository.NodeRef branchNodeRef, org.alfresco.service.cmr.repository.NodeRef branchToNodeRef, org.alfresco.service.cmr.version.VersionType versionType, String description)
    mergeBranch.
    org.alfresco.service.cmr.repository.NodeRef
    mergeBranch(org.alfresco.service.cmr.repository.NodeRef branchNodeRef, org.alfresco.service.cmr.repository.NodeRef branchToNodeRef, org.alfresco.service.cmr.version.VersionType versionType, String description, boolean impactWused, boolean rename)
    mergeBranch.
    org.alfresco.service.cmr.repository.NodeRef
    revertVersion(org.alfresco.service.cmr.repository.NodeRef versionNodeRef)
    revertVersion.
    void
    updateLastVersionLabel(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, String versionLabel)
    updateLastVersionLabel.
  • Method Details

    • cancelCheckOut

      void cancelCheckOut(org.alfresco.service.cmr.repository.NodeRef origNodeRef, org.alfresco.service.cmr.repository.NodeRef workingCopyNodeRef)

      cancelCheckOut.

      Parameters:
      origNodeRef - a NodeRef object.
      workingCopyNodeRef - a NodeRef object.
    • getEntityVersion

      org.alfresco.service.cmr.repository.NodeRef getEntityVersion(org.alfresco.service.cmr.version.Version version)

      getEntityVersion.

      Parameters:
      version - a Version object.
      Returns:
      a NodeRef object.
    • deleteVersionHistory

      void deleteVersionHistory(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)

      deleteVersionHistory.

      Parameters:
      entityNodeRef - a NodeRef object.
    • getEntitiesHistoryFolder

      org.alfresco.service.cmr.repository.NodeRef getEntitiesHistoryFolder()

      getEntitiesHistoryFolder.

      Returns:
      a NodeRef object.
    • getAllVersions

      List<EntityVersion> getAllVersions(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)

      getAllVersions.

      Parameters:
      entityNodeRef - a NodeRef object.
      Returns:
      a List object.
    • getVersionHistoryNodeRef

      org.alfresco.service.cmr.repository.NodeRef getVersionHistoryNodeRef(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, boolean shouldCreate)

      getVersionHistoryNodeRef.

      Parameters:
      entityNodeRef - a NodeRef object.
      shouldCreate - a boolean
      Returns:
      a NodeRef object.
    • buildVersionHistory

      List<org.alfresco.service.cmr.repository.NodeRef> buildVersionHistory(org.alfresco.service.cmr.repository.NodeRef versionHistoryRef, org.alfresco.service.cmr.repository.NodeRef nodeRef)

      buildVersionHistory.

      Parameters:
      versionHistoryRef - a NodeRef object.
      nodeRef - a NodeRef object.
      Returns:
      a List object.
    • getAllVersionAndBranches

      List<EntityVersion> getAllVersionAndBranches(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)

      getAllVersionAndBranches.

      Parameters:
      entityNodeRef - a NodeRef object.
      Returns:
      a List object.
    • getAllVersionBranches

      List<org.alfresco.service.cmr.repository.NodeRef> getAllVersionBranches(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)

      getAllVersionBranches.

      Parameters:
      entityNodeRef - a NodeRef object.
      Returns:
      a List object.
    • createVersion

      org.alfresco.service.cmr.repository.NodeRef createVersion(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, Map<String,Serializable> versionProperties)

      createVersion.

      Parameters:
      entityNodeRef - a NodeRef object.
      versionProperties - a Map object.
      Returns:
      a NodeRef object.
    • createVersion

      org.alfresco.service.cmr.repository.NodeRef createVersion(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, Map<String,Serializable> versionProperties, Date effectiveDate)

      createVersion.

      Parameters:
      entityNodeRef - a NodeRef object
      versionProperties - a Map object
      effectiveDate - a Date object
      Returns:
      a NodeRef object
    • createInitialVersion

      void createInitialVersion(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)

      createInitialVersion.

      Parameters:
      entityNodeRef - a NodeRef object.
    • afterCancelCheckOut

      void afterCancelCheckOut(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)

      afterCancelCheckOut.

      Parameters:
      entityNodeRef - a NodeRef object.
    • createBranch

      org.alfresco.service.cmr.repository.NodeRef createBranch(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, org.alfresco.service.cmr.repository.NodeRef parentRef)

      createBranch.

      Parameters:
      entityNodeRef - a NodeRef object.
      parentRef - a NodeRef object.
      Returns:
      a NodeRef object.
    • deleteEntityVersion

      void deleteEntityVersion(org.alfresco.service.cmr.version.Version version)

      deleteEntityVersion.

      Parameters:
      version - a Version object.
    • impactWUsed

      void impactWUsed(org.alfresco.service.cmr.repository.NodeRef newEntityNodeRef, org.alfresco.service.cmr.version.VersionType versionType, String description, Date effectiveDate)

      impactWUsed.

      Parameters:
      newEntityNodeRef - a NodeRef object.
      versionType - a VersionType object.
      description - a String object.
      effectiveDate - a Date object
    • mergeBranch

      org.alfresco.service.cmr.repository.NodeRef mergeBranch(org.alfresco.service.cmr.repository.NodeRef branchNodeRef, org.alfresco.service.cmr.repository.NodeRef branchToNodeRef, org.alfresco.service.cmr.version.VersionType versionType, String description)

      mergeBranch.

      Parameters:
      branchNodeRef - a NodeRef object.
      branchToNodeRef - a NodeRef object.
      versionType - a VersionType object.
      description - a String object.
      Returns:
      a NodeRef object.
    • mergeBranch

      org.alfresco.service.cmr.repository.NodeRef mergeBranch(org.alfresco.service.cmr.repository.NodeRef branchNodeRef, org.alfresco.service.cmr.repository.NodeRef branchToNodeRef, org.alfresco.service.cmr.version.VersionType versionType, String description, boolean impactWused, boolean rename)

      mergeBranch.

      Parameters:
      branchNodeRef - a NodeRef object.
      branchToNodeRef - a NodeRef object.
      versionType - a VersionType object.
      description - a String object.
      impactWused - a boolean.
      rename - a boolean.
      Returns:
      a NodeRef object.
    • mergeBranch

      org.alfresco.service.cmr.repository.NodeRef mergeBranch(org.alfresco.service.cmr.repository.NodeRef branchNodeRef, Date newEffectivity)

      mergeBranch.

      Parameters:
      branchNodeRef - a NodeRef object.
      newEffectivity - a Date object
      Returns:
      a NodeRef object.
    • updateLastVersionLabel

      void updateLastVersionLabel(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, String versionLabel)

      updateLastVersionLabel.

      Parameters:
      entityNodeRef - a NodeRef object.
      versionLabel - a String object.
    • extractVersion

      org.alfresco.service.cmr.repository.NodeRef extractVersion(org.alfresco.service.cmr.repository.NodeRef entity1)

      extractVersion.

      Parameters:
      entity1 - a NodeRef object
      Returns:
      a NodeRef object
    • createInitialVersionWithProps

      void createInitialVersionWithProps(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, Map<org.alfresco.service.namespace.QName,Serializable> before)

      createInitialVersionWithProps.

      Parameters:
      entityNodeRef - a NodeRef object
      before - a Map object
    • revertVersion

      org.alfresco.service.cmr.repository.NodeRef revertVersion(org.alfresco.service.cmr.repository.NodeRef versionNodeRef) throws IllegalAccessException

      revertVersion.

      Parameters:
      versionNodeRef - a NodeRef object
      Returns:
      a NodeRef object
      Throws:
      IllegalAccessException - if any.
    • createInitialVersion

      void createInitialVersion(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, Date effectiveDate)

      createInitialVersion.

      Parameters:
      entityNodeRef - a NodeRef object
      effectiveDate - a Date object
    • convertVersion

      org.alfresco.service.cmr.repository.NodeRef convertVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef)

      convertVersion.

      Parameters:
      nodeRef - a NodeRef object
      Returns:
      a NodeRef object
    • findOldVersionWUsed

      Set<org.alfresco.service.cmr.repository.NodeRef> findOldVersionWUsed(org.alfresco.service.cmr.repository.NodeRef originalEntity, Set<org.alfresco.service.cmr.repository.NodeRef> visited, List<org.alfresco.service.cmr.repository.NodeRef> ignoredItems, int maxProcessedNodes, org.apache.commons.lang3.mutable.MutableInt currentCount, String path)

      findOldVersionWUsed.

      Parameters:
      originalEntity - a NodeRef object
      visited - a Set object
      ignoredItems - a List object
      maxProcessedNodes - a int
      currentCount - a MutableInt object
      path - a String object
      Returns:
      a Set object
    • findOldVersionWUsed

      Set<org.alfresco.service.cmr.repository.NodeRef> findOldVersionWUsed(org.alfresco.service.cmr.repository.NodeRef sourceEntity)

      findOldVersionWUsed.

      Parameters:
      sourceEntity - a NodeRef object
      Returns:
      a Set object