Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.alfresco.service.cmr.version
Interface Version
All Superinterfaces:
Serializable

public interface Version
extends 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
PROP_DESCRIPTION
          Names of the system version properties
Method Summary
getCreatedDate()
          Deprecated. use getFrozenModifiedDate
getCreator()
          Deprecated. use getFrozenModifier
getDescription()
          Helper method to get the version description.
getFrozenModifiedDate()
          Helper method to get the frozen (original) modified date for this version of the node
getFrozenModifier()
          Helper method to get the frozen (original) modifier for this version of the node
getFrozenStateNodeRef()
          Gets the reference to the node that contains the frozen state of the version.
getVersionedNodeRef()
          Gets a reference to the node that this version was created from.
getVersionLabel()
          Helper method to get the version label from the version property data.
getVersionProperties()
          Get the map containing the version property values
getVersionProperty(String name)
          Gets the value of a named version property.
getVersionType()
          Helper method to get the version type.
Field Detail
PROP_DESCRIPTION
public static final String PROP_DESCRIPTION
Names of the system version properties
See Also:
Constant Field Values
Method Detail
getCreatedDate
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
String getCreator()
Deprecated. use getFrozenModifier
Helper method to get the creator of the version.
Returns:
the creator of the version

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

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

getVersionLabel
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
String getDescription()
Helper method to get the version description.
Returns:
the version description

getVersionProperties
Map<String,SerializablegetVersionProperties()
Get the map containing the version property values
Returns:
the map containing the version properties

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

getVersionedNodeRef
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
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)

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2005–2016 Alfresco Software. All rights reserved.

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.