Package org.alfresco.service.cmr.version

Interface Version

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    VersionImpl
    @AlfrescoPublicApi
public interface Version
extends java.io.Serializable
    Version interface. Allows access to version property values and frozen state node references. The version history tree can also be navigated.
    Author:
    Roy Wetherall, janv

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PROP_DESCRIPTION
      Names of the system version properties

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      java.util.Date getCreatedDate()
      Deprecated.
      use getFrozenModifiedDate
      java.lang.String getCreator()
      Deprecated.
      use getFrozenModifier
      java.lang.String getDescription()
      Helper method to get the version description.
      java.util.Date getFrozenModifiedDate()
      Helper method to get the frozen (original) modified date for this version of the node
      java.lang.String getFrozenModifier()
      Helper method to get the frozen (original) modifier for this version of the node
      org.alfresco.service.cmr.repository.NodeRef getFrozenStateNodeRef()
      Gets the reference to the node that contains the frozen state of the version.
      org.alfresco.service.cmr.repository.NodeRef getVersionedNodeRef()
      Gets a reference to the node that this version was created from.
      java.lang.String getVersionLabel()
      Helper method to get the version label from the version property data.
      java.util.Map<java.lang.String,​java.io.Serializable> getVersionProperties()
      Get the map containing the version property values
      java.io.Serializable getVersionProperty​(java.lang.String name)
      Gets the value of a named version property.
      VersionType getVersionType()
      Helper method to get the version type.

    • Field Detail

      • PROP_DESCRIPTION

        static final java.lang.String PROP_DESCRIPTION
        Names of the system version properties
        See Also:
        Constant Field Values

    • Method Detail

      • getCreatedDate

        java.util.Date getCreatedDate()
        Deprecated.
        use getFrozenModifiedDate
        Helper method to get the created date from the version property data.
        Returns:
        the date the version was created

      • getCreator

        java.lang.String getCreator()
        Deprecated.
        use getFrozenModifier
        Helper method to get the creator of the version.
        Returns:
        the creator of the version

      • getFrozenModifiedDate

        java.util.Date getFrozenModifiedDate()
        Helper method to get the frozen (original) modified date for this version of the node
        Returns:
        the modified date

      • getFrozenModifier

        java.lang.String getFrozenModifier()
        Helper method to get the frozen (original) modifier for this version of the node
        Returns:
        the modifier

      • getVersionLabel

        java.lang.String getVersionLabel()
        Helper method to get the version label from the version property data.
        Returns:
        the version label

      • getVersionType

        VersionType getVersionType()
        Helper method to get the version type.
        Returns:
        the value of the version type as an enum value

      • getDescription

        java.lang.String getDescription()
        Helper method to get the version description.
        Returns:
        the version description

      • getVersionProperties

        java.util.Map<java.lang.String,​java.io.Serializable> getVersionProperties()
        Get the map containing the version property values
        Returns:
        the map containing the version properties

      • getVersionProperty

        java.io.Serializable getVersionProperty​(java.lang.String name)
        Gets the value of a named version property.
        Parameters:
        name - the name of the property
        Returns:
        the value of the property

      • getVersionedNodeRef

        org.alfresco.service.cmr.repository.NodeRef getVersionedNodeRef()
        Gets a reference to the node that this version was created from.

        Note that this reference will be to the current state of the versioned node which may now correspond to a later version.

        Returns:
        a node reference (to the versioned node in the 'live' store)

      • getFrozenStateNodeRef

        org.alfresco.service.cmr.repository.NodeRef getFrozenStateNodeRef()
        Gets the reference to the node that contains the frozen state of the version.
        Returns:
        a node reference (to the version node in the 'version' store)